Custom Functions

Chapter 8. Custom Functions

Smarty comes with several custom functions that you can use in the templates.


{assign} is used for assigning template variables during the execution of the template.

Attribute NameTypeRequiredDefaultDescription
varstringYesn/aThe name of the variable being assigned
valuestringYesn/aThe value being assigned

Example 8-1. {assign}

{assign var="name" value="Bob"}

The value of $name is {$name}.

The above example will output:

The value of $name is Bob.

Example 8-2. Accessing {assign} variables from a PHP script.

To access {assign} variables from php use get_template_vars(). However, the variables are only available after/during template execution as in the following example

{* index.tpl *}
{assign var="foo" value="Smarty"}

// this will output nothing as the template has not been executed
echo $smarty->get_template_vars('foo');

// fetch the template to a dead variable
$dead $smarty->fetch('index.tpl');

// this will output 'smarty' as the template has been executed
echo $smarty->get_template_vars('foo');

$smarty->assign('foo','Even smarter');

// this will output 'Even smarter'
echo $smarty->get_template_vars('foo');


The following functions can also optionally assign template variables.

{capture}, {include}, {include_php}, {insert}, {counter}, {cycle}, {eval}, {fetch}, {math}, {textformat}

See also assign() and get_template_vars().

© Copyright 2003-2023 The ultimate PHP Editor and PHP IDE site.