Template functions Template Function

 

void smarty_function_name(array $params, object &$smarty)

 

All attributes passed to template functions from the template are contained in$ ParamsAs an associative array. Either access those values directly, e.g.$ Params ['start']Or useExtract ($ Params)To import them into the symbol table.

All attributes passed by the template to the template function are included in the parameter array.$ ParamsYou can use:$ Params ['start']You can also useExtract ($ Params)To import all values to the symbol table.

The output (return value) of the function will be substituted in place of the function tag in the template (Fetch ()Function, for example). Alternatively, the function can simply perform some other task without any output (Assign ()Function ).

The content of the function output (Return Value) replaces the position where the function name appears in the template (for example:Fetch ()Function ). At the same time, the function may only execute some background tasks without any output.

If the function needs to assign some variables to the template or use some other smarty-provided functionality, it can use the supplied$ SmartyObject to do so.

If the function needs to add variables to the template or use some functions provided by smarty, you can use$ SmartyObject implementation.

See also: register_function (), unregister_function ().

Example 16-1. Function plugin with output Example 16-1: Output plug-in Function <?php/* * Smarty plugin * ------------------------------------------------------------- * File: function.eightball.php * Type: function * Name: eightball * Purpose: outputs a random magic answer * ------------------------------------------------------------- */function smarty_function_eightball($params, &$smarty){ $answers = array('Yes', 'No', 'No way', 'Outlook not so good', 'Ask again soon', 'Maybe in your reality'); $result = array_rand($answers); return $answers[$result];}?>

Which can be used in the template:

The method of calling the template is as follows:

Question: Will we ever have time travel?Answer: {eightball}.

Example 16-2. Function plugin Without Output Example 16-2: No output plug-in Function <?php/* * Smarty plugin * ------------------------------------------------------------- * File: function.assign.php * Type: function * Name: assign * Purpose: assign a value to a template variable * ------------------------------------------------------------- */function smarty_function_assign($params, &$smarty){ extract($params); if (empty($var)) { $smarty->trigger_error("assign: missing 'var' parameter"); return; } if (!in_array('value', array_keys($params))) { $smarty->trigger_error("assign: missing 'value' parameter"); return; } $smarty->assign($var, $value);}?>