iWink, fullservice digital agency
+
Temma, the MVC framework based on Smarty
diff --git a/5.x/search/search_index.json b/5.x/search/search_index.json index f5229970..e3b6d172 100644 --- a/5.x/search/search_index.json +++ b/5.x/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Smarty Documentation","text":"Smarty is a template engine for PHP, facilitating the separation of presentation (HTML/CSS) from application logic.
It allows you to write templates, using variables, modifiers, functions and comments, like this:
<h1>{$title|escape}</h1>\n\n<p>\n The number of pixels is: {math equation=\"x * y\" x=$height y=$width}.\n</p>\nWhen this template is rendered, with the value \"Hello world\" for the variable $title, 640 for $width, and 480 for $height, the result is:
<h1>Hello world</h1>\n\n<p>\n The number of pixels is: 307200.\n</p>\nSome of Smarty's features:
{$foo}, {{$foo}}, <!--{$foo}-->, etc.{if}..{elseif}..{else}..{/if} constructs are passed to the PHP parser, so the {if...} expression syntax can be as simple or as complex an evaluation as you like.sections, if's etc.Under the hood, Smarty \"compiles\" (basically copies and converts) the templates into PHP scripts. This happens once when each template is first invoked, and then the compiled versions are used from that point forward. Smarty takes care of this for you, so the template designer just edits the Smarty templates and never has to manage the compiled versions. This approach keeps the templates easy to maintain, and yet keeps execution times extremely fast since the compiled code is just PHP. And of course, all PHP scripts take advantage of PHP op-code caches such as APC.
"},{"location":"features/#template-inheritance","title":"Template Inheritance","text":"Template inheritance was introduced in Smarty 3. Before template inheritance, we managed our templates in pieces such as header and footer templates. This organization lends itself to many problems that require some hoop-jumping, such as managing content within the header/footer on a per-page basis. With template inheritance, instead of including other templates we maintain our templates as single pages. We can then manipulate blocks of content within by inheriting them. This makes templates intuitive, efficient and easy to manage. See Template Inheritance for more info.
"},{"location":"features/#why-not-use-xmlxslt-syntax","title":"Why not use XML/XSLT syntax?","text":"There are a couple of good reasons. First, Smarty can be used for more than just XML/HTML based templates, such as generating emails, javascript, CSV, and PDF documents. Second, XML/XSLT syntax is even more verbose and fragile than PHP code! It is perfect for computers, but horrible for humans. Smarty is about being easy to read, understand and maintain.
"},{"location":"features/#template-security","title":"Template Security","text":"Although Smarty insulates you from PHP, you still have the option to use it in certain ways if you wish. Template security forces the restriction of PHP (and select Smarty functions.) This is useful if you have third parties editing templates, and you don't want to unleash the full power of PHP or Smarty to them.
"},{"location":"features/#integration","title":"Integration","text":"Sometimes Smarty gets compared to Model-View-Controller (MVC) frameworks. Smarty is not an MVC, it is just the presentation layer, much like the View (V) part of an MVC. As a matter of fact, Smarty can easily be integrated as the view layer of an MVC. Many of the more popular ones have integration instructions for Smarty, or you may find some help here in the forums and documentation.
"},{"location":"features/#other-template-engines","title":"Other Template Engines","text":"Smarty is not the only engine following the \"Separate Programming Code from Presentation\" philosophy. For instance, Python has template engines built around the same principles such as Django Templates and CheetahTemplate. Note: Languages such as Python do not mix with HTML natively, which give them the advantage of proper programming code separation from the outset. There are libraries available to mix Python with HTML, but they are typically avoided.
"},{"location":"features/#what-smarty-is-not","title":"What Smarty is Not","text":"Smarty is not an application development framework. Smarty is not an MVC. Smarty is not an alternative to Laravel, Symfony, CodeIgniter, or any of the other application development frameworks for PHP.
Smarty is a template engine, and works as the (V)iew component of your application. Smarty can easily be coupled to any of the engines listed above as the view component. No different than any other software, Smarty has a learning curve. Smarty does not guarantee good application design or proper separation of presentation, this still needs to be addressed by a competent developer and web designer.
"},{"location":"features/#is-smarty-right-for-me","title":"Is Smarty Right for Me?","text":"Smarty is not meant to be a tool for every job. The important thing is to identify if Smarty fits your needs. There are some important questions to ask yourself:
"},{"location":"features/#template-syntax","title":"Template Syntax","text":"Are you content with PHP tags mixed with HTML? Are your web designers comfortable with PHP? Would your web designers prefer a tag-based syntax designed for presentation? Some experience working with both Smarty and PHP helps answer these questions.
"},{"location":"features/#the-business-case","title":"The Business Case","text":"Is there a requirement to insulate the templates from PHP? Do you have untrusted parties editing templates that you do not wish to unleash the power of PHP to? Do you need to programmatically control what is and is not available within the templates? Smarty supplies these capabilities by design.
"},{"location":"features/#feature-set","title":"Feature set","text":"Does Smarty's features such as caching, template inheritance and plugin architecture save development cycles writing code that would be needed otherwise? Does the codebase or framework you plan on using have the features you need for the presentation component?
"},{"location":"features/#sites-using-smarty","title":"Sites using Smarty","text":"Many well-known PHP projects make use of Smarty such as XOOPS CMS, CMS Made Simple, Tiki Wiki CMS Groupware and X-Cart to name a few.
"},{"location":"features/#summary","title":"Summary","text":"Whether you are using Smarty for a small website or massive enterprise solution, it can accommodate your needs. There are numerous features that make Smarty a great choice:
Smarty can be run with PHP 7.2 to PHP 8.4.
"},{"location":"getting-started/#installation","title":"Installation","text":"Smarty can be installed with Composer.
To get the latest stable version of Smarty use:
composer require smarty/smarty\nTo get the latest, unreleased version, use:
composer require smarty/smarty:dev-master\nTo get the previous stable version of Smarty, Smarty 4, use:
composer require smarty/smarty:^4\nHere's how you create an instance of Smarty in your PHP scripts:
<?php\n\n// Instantiated via composer\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n// or ...\n\n// Instantiated directly\nrequire(\"/path/to/smarty/libs/Smarty.class.php\");\nuse Smarty\\Smarty;\n$smarty = new Smarty();\nNow that the library files are in place, it's time to set up the Smarty directories for your application.
Smarty requires four directories which are by default named templates, configs, templates_c and cache relative to the current working directory.
The defaults can be changed as follows:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->setTemplateDir('/some/template/dir');\n$smarty->setConfigDir('/some/config/dir');\n$smarty->setCompileDir('/some/compile/dir');\n$smarty->setCacheDir('/some/cache/dir');\nThe compile dir and cache dir need to be writable for the user running the PHP script.
Note
This is usually user \"nobody\" and group \"nobody\". For OS X users, the default is user \"www\" and group \"www\". If you are using Apache, you can look in your httpd.conf file to see what user and group are being used.
chown nobody:nobody /web/www.example.com/guestbook/templates_c/\nchmod 770 /web/www.example.com/guestbook/templates_c/\n\nchown nobody:nobody /web/www.example.com/guestbook/cache/\nchmod 770 /web/www.example.com/guestbook/cache/\nYou can verify if your system has the correct access rights for these directories with testInstall():
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->setTemplateDir('/some/template/dir');\n$smarty->setConfigDir('/some/config/dir');\n$smarty->setCompileDir('/some/compile/dir');\n$smarty->setCacheDir('/some/cache/dir');\n$smarty->testInstall();\nNow, let's create the index.tpl file that Smarty will display. This needs to be located in the $template_dir.
{* Smarty *}\n<h1>Hello {$name|escape}, welcome to Smarty!</h1>\nNote
{* Smarty *} is a template comment. It is not required, but it is good practice to start all your template files with this comment. It makes the file easy to recognize regardless of the file extension. For example, text editors could recognize the file and turn on special syntax highlighting.
Now lets edit our php file. We'll create an instance of Smarty, assign() a template variable and display() the index.tpl file.
<?php\n\nrequire 'vendor/autoload.php';\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setTemplateDir('/web/www.example.com/guestbook/templates/');\n$smarty->setCompileDir('/web/www.example.com/guestbook/templates_c/');\n$smarty->setConfigDir('/web/www.example.com/guestbook/configs/');\n$smarty->setCacheDir('/web/www.example.com/guestbook/cache/');\n\n$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\nNote
In our example, we are setting absolute paths to all the Smarty directories. If /web/www.example.com/guestbook/ is within your PHP include_path, then these settings are not necessary. However, it is more efficient and (from experience) less error-prone to set them to absolute paths. This ensures that Smarty is getting files from the directories you intended.
Now, run your PHP file. You should see \"Hello Ned, welcome to Smarty!\"
You have completed the basic setup for Smarty!
"},{"location":"getting-started/#escaping","title":"Escaping","text":"You may have noticed that the example template above renders the $name variable using the escape modifier. This modifier makes string 'safe' to use in the context of an HTML page.
If you are primarily using Smarty for HTML-pages, it is recommended to enable automatic escaping. This way, you don't have to add |escape to every variable you use on a web page. Smarty will handle it automatically for you!
Enable auto-escaping for HTML as follows:
$smarty->setEscapeHtml(true);\nThis is a continuation of the basic installation, please read that first!
A slightly more flexible way to set up Smarty is to extend the Smarty class and initialize your Smarty environment. So instead of repeatedly setting directory paths, assigning the same vars, etc., we can do that in one place.
<?php\n\nuse Smarty\\Smarty;\n\nclass My_GuestBook extends Smarty {\n\n public function __construct()\n {\n parent::__construct();\n\n $this->setTemplateDir('/web/www.example.com/guestbook/templates/');\n $this->setCompileDir('/web/www.example.com/guestbook/templates_c/');\n $this->setConfigDir('/web/www.example.com/guestbook/configs/');\n $this->setCacheDir('/web/www.example.com/guestbook/cache/');\n\n $this->setEscapeHtml(true);\n\n $this->caching = Smarty::CACHING_LIFETIME_CURRENT;\n $this->assign('app_name', 'Guest Book');\n }\n\n}\nNow, we can use My_GuestBook instead of Smarty in our scripts:
<?php\n$smarty = new My_GuestBook();\n$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\nSmarty is a template engine for PHP. More specifically, it facilitates a manageable way to separate application logic and content from its presentation. This is best described in a situation where the application programmer and the template designer play different roles, or in most cases are not the same person.
For example, let's say you are creating a web page that is displaying a newspaper article.
The article $headline, $tagline, $author and $body are content elements, they contain no information about how they will be presented. They are passed into Smarty by the application.
Then the template designer edits the templates and uses a combination of HTML tags and template tags to format the presentation of these variables with elements such as tables, div\\'s, background colors, font sizes, style sheets, svg etc.
One day the programmer needs to change the way the article content is retrieved, ie a change in application logic. This change does not affect the template designer, the content will still arrive in the template exactly the same.
Likewise, if the template designer wants to completely redesign the templates, this would require no change to the application logic.
Therefore, the programmer can make changes to the application logic without the need to restructure templates, and the template designer can make changes to templates without breaking application logic.
The Smarty design was largely driven by these goals: - clean separation of presentation from application code - PHP backend, Smarty template frontend - complement PHP, not replace it - fast development/deployment for programmers and designers - quick and easy to maintain - syntax easy to understand, no PHP knowledge necessary - flexibility for custom development - security: insulation from PHP - free, open source
"},{"location":"philosophy/#two-camps-of-thought","title":"Two camps of thought","text":"When it comes to templating in PHP, there are basically two camps of thought. The first camp exclaims that \\\"PHP is a template engine\\\". This approach simply mixes PHP code with HTML. Although this approach is fastest from a pure script-execution point of view, many would argue that the PHP syntax is messy and complicated when mixed with tagged markup such as HTML.
The second camp exclaims that presentation should be void of all programming code, and instead use simple tags to indicate where application content is revealed. This approach is common with other template engines (even in other programming languages), and is also the approach that Smarty takes. The idea is to keep the templates focused squarely on presentation, void of application code, and with as little overhead as possible.
"},{"location":"philosophy/#why-is-separating-php-from-templates-important","title":"Why is separating PHP from templates important?","text":"Two major benefits:
SYNTAX: Templates typically consist of semantic markup such as HTML. PHP syntax works well for application code, but quickly degenerates when mixed with HTML. Smarty\\'s simple {tag} syntax is designed specifically to express presentation. Smarty focuses your templates on presentation and less on \\\"code\\\". This lends to quicker template deployment and easier maintenance. Smarty syntax requires no working knowledge of PHP, and is intuitive for programmers and non-programmers alike.
INSULATION: When PHP is mixed with templates, there are no restrictions on what type of logic can be injected into a template. Smarty insulates the templates from PHP, creating a controlled separation of presentation from business logic. Smarty also has security features that can further enforce restrictions on templates.
A common question: \"Web designers have to learn a syntax anyway, why not PHP?\" Of course web designers can learn PHP, and they may already be familiar with it. The issue isn't their ability to learn PHP, it is about the consequences of mixing PHP with HTML. If designers use PHP, it is too easy to add code into templates that doesn't belong there (you just handed them a swiss-army knife when they just needed a knife.) You can teach them the rules of application design, but this is probably something they don't really need to learn (now they are developers!) The PHP manual is also an overwhelming pile of information to sift through. It is like handing the owner of a car the factory assembly manual when all they need is the owners manual. Smarty gives web designers exactly the tools they need, and gives developers fine-grained control over those tools. The simplicity of the tag-based syntax is also a huge welcome for designers, it helps them streamline the organization and management of templates.
"},{"location":"upgrading/","title":"Upgrading from an older version","text":""},{"location":"upgrading/#upgrading-from-v4-to-v5","title":"Upgrading from v4 to v5","text":"Smarty 5 adds support for PHP8.2 and drops support for PHP7.1. Smarty also adds support for new features such as the ternary operator ({$test ? $a : $b} and {$var ?: $value_if_falsy}), the null coalescing operator ({$var ?? $value_if_null}) and positional parameters for custom tags. Smarty 5 also has a brand-new extension architecture that allows you to write neat extension packs.
All Smarty code has been moved into the \\Smarty namespace. This reduces the chance of conflicts with other (your) code.
For simple use-cases, you only need to add use Smarty\\Smarty; to your script and everything will work.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('homepage.tpl');\nIf you extend Smarty or use Smarty plug-ins, please review your code to see if they assume specific class or method names. E.g.: Smarty_Internal_Template is now \\Smarty\\Template\\, SmartyException is now \\Smarty\\Exception.
Template variable scope bubbling has been simplified and made more consistent. The global scope now equals the Smarty scope in order to avoid global state side effects. Please read the documentation on language variable scope for more details.
Also, {config_load} no longer has a scope parameter, which means you can no longer load config from inside your template into the global scope (again, to avoid global state side effects). If you need to set global config, use the configLoad API method from your PHP code.
You can no longer use native PHP-functions or userland functions in your templates without registering them. If you need a function in your templates, register it first.
The easiest way to do so is as follows:
// native PHP functions used as modifiers need to be registered\n$smarty->registerPlugin('modifier', 'substr', 'substr');\n\n// userland PHP functions used as modifiers need to be registered\n$smarty->registerPlugin('modifier', 'my_special_func', 'my_special_func');\nBut you may want to consider writing a proper extension.
"},{"location":"upgrading/#passing-parameters-by-reference","title":"Passing parameters by reference","text":"You cannot use plugins that expect a parameter by reference anymore. PHP-function such as reset(), prev(), next() and end() can be registered as plugin, but they won't work because they expect a parameter by reference and Smarty will try to pass it by value.
Smarty 4 still supported some tags that have been carried over from previous version, but have never been documented.
{block_parent} should be replaced with {$smarty.block.parent}{parent} should be replaced with {$smarty.block.parent}{block_child} should be replaced with {$smarty.block.child}{child} should be replaced with {$smarty.block.child}
{make_nocache} is no longer supported
{insert} is no longer supportedIn Smarty 4, you could make many configuration changes by directly accessing public properties on the Smarty object in PHP. In many cases, these properties have been made private, and you should now use the appropriate setter method:
$smarty->left_delimiter should be replaced with $smarty->getLeftDelimiter()/$smarty->setLeftDelimiter()$smarty->right_delimiter should be replaced with $smarty->getRightDelimiter()/$smarty->setRightDelimiter()$smarty->autoload_filters should be replaced with $smarty->registerFilter()$smarty->template_dir should be replaced with $smarty->setTemplateDir()$smarty->cache_dir should be replaced with $smarty->setCacheDir()$smarty->compile_dir should be replaced with $smarty->setCompileDir()Other public properties have been removed altogether, and you should no longer access them:
$smarty->_current_file$smarty->allow_ambiguous_resources (ambiguous resources handlers should still work)$smarty->registered_filters$smarty->direct_access_security$smarty->trusted_dir$smarty->allow_php_templates$smarty->php_functions$smarty->php_modifiersWe have dropped support for $smarty->plugins_dir and $smarty->use_include_path. Use $smarty->addPluginsDir() or consider writing a proper extension.
The 'insert' plugin type is no longer supported.
The $cache_attrs parameter for registered plugins is no longer supported.
Search your code for the following changes:
$smarty->getTags() is no longer supported$smarty->appendByRef() should be replaced with $smarty->append()$smarty->assignByRef() should be replaced with $smarty->assign()$smarty->loadPlugin() should be replaced with $smarty->registerPlugin()Smarty v4 allowed setting (internal) properties for which no setter existed by using magic methods that start with either set or get. This has been removed in Smarty 5.
For example, $smarty->setErrorUnassigned(true); would set the error_unassigned property.
Every setter of getter that was ever documented or unit tested has been kept.
"},{"location":"upgrading/#removed-php-constants","title":"Removed PHP constants","text":"The following constants have been removed to prevent global side effects.
SMARTY_DIRSMARTY_SYSPLUGINS_DIRSMARTY_PLUGINS_DIRSMARTY_MBSTRINGSMARTY_HELPER_FUNCTIONS_LOADED<script> tags lo longer have deprecated type=\"text/javascript\" or language=\"Javascript\" attributes{include|dot:\"x-template-id\" file=\"included.dot.tpl\"}Smarty 4 is mostly identical to Smarty 3. Most notably, it adds support for PHP8 and drops support for PHP7.0 and below. Additionally, some deprecated features that have long been discouraged have been dropped from the language.
"},{"location":"upgrading/#muting-php8-warnings","title":"Muting PHP8 warnings","text":"If you simultaneously upgrade Smarty to v4 van PHP to v8, you may notice your error logs filling up with warnings about undefined or null template vars due to a change in how PHP handles these. This may be helpful to spot errors, but if you find this annoying, you can use $smarty->muteUndefinedOrNullWarnings() to make Smarty convert these warnings into notices.
You can no longer user ASP-style tags like <% %> and <%= %> in your templates. Replace them with {...} tags.
Check your codebase for SmartyBC. We have dropped deprecated API calls that where only accessible through the SmartyBC class.
We have completely dropped support for {php} and {include_php} tags and embedded PHP in templates. Check your templates for this, and rewrite any embedded PHP blocks, by moving logic to your PHP files or by creating a custom tag.
Search your code for the following changes:
SMARTY_RESOURCE_CHAR_SET and SMARTY_RESOURCE_DATE_FORMAT constants have been removedSmarty::muteExpectedErrors and Smarty::unmuteExpectedErrors API methods have been removedSmarty::getVariable method has been removed. Use Smarty::getTemplateVars instead.For installation instructies, please see the getting started section.
"},{"location":"api/basics/#rendering-a-template","title":"Rendering a template","text":"Here's how you create an instance of Smarty in your PHP scripts:
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\nYou now have a Smarty object that you can use to render templates.
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('string:The current smarty version is: {$smarty.version}.');\n// or \necho $smarty->fetch('string:The current smarty version is: {$smarty.version}.');\nYou probably want to manage your templates as files. Create a subdirectory called 'templates' and then configure Smarty to use that:
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setTemplateDir(__DIR__ . '/templates');\nSay you have a template file called 'version.tpl', stored in the 'templates' directory like this:
<h1>Hi</h1>\nThe current smarty version is: {$smarty.version|escape}.\nYou can now render this, using:
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setTemplateDir(__DIR__ . '/templates');\n$smarty->display('version.tpl');\nTemplates start to become really useful once you add variables to the mix.
Create a template called 'footer.tpl' in the 'templates' directory like this:
<small>Copyright {$companyName|escape}</small>\nNow assign a value to the 'companyName' variable and render your template like this:
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setTemplateDir(__DIR__ . '/templates');\n$smarty->assign('companyName', 'AC & ME Corp.');\n$smarty->display('footer.tpl');\nRun this, and you will see:
<small>Copyright AC & ME Corp.</small>\nNote how the escape modifier translated the & character into the proper HTML syntax &. Read more about auto-escaping in the next section.
By default, Smarty looks for templates to render in ./templates.
You can change this, or even use multiple paths to use when looking for templates.
If you need to change this, you can use setTemplateDir() or addTemplateDir(). Use getTemplateDir() to retrieve the configured paths.
<?php\n\n // set a single directory where the config files are stored\n$smarty->setTemplateDir('./templates');\n\n// set multiple directories where templates are stored\n$smarty->setTemplateDir(['./templates', './templates_2', './templates_3']);\n\n// add directory where templates files are stored to the current list of dirs\n$smarty->addTemplateDir('./templates_1');\n\n// add multiple directories to the current list of dirs\n$smarty->addTemplateDir([\n './templates_2',\n './templates_3',\n]);\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n ->addTemplateDir('./templates_1')\n ->addTemplateDir('./templates_2');\n\n// insert a template dir before exising template dirs\n$smarty->prependTemplateDir('./more_important_templates')\n\n// get all directories where config files are stored\n$template_dirs = $smarty->getTemplateDir();\nvar_dump($template_dirs); // array\n\n// get directory identified by key\n$template_dir = $smarty->getTemplateDir(0);\nvar_dump($template_dir); // string\nSmarty compiles templates to native PHP to be as fast as possible. The default path where these PHP-files are stored is ./templates_c.
If you need to change this, you can use setCompileDir(). Use getCompileDir() to retrieve the configured path.
<?php\n\n// set another path to store compiled templates\n$smarty->setCompileDir('/data/compiled_templates');\n\n// get directory where compiled templates are stored\n$compileDir = $smarty->getCompileDir();\nSmarty can load data from config files. By default, Smarty loads the config files from ./configs.
You can change this, or even use multiple paths to use when looking for config files.
If you need to change this, you can use setConfigDir() or addConfigDir(). Use getConfigDir() to retrieve the configured paths.
<?php\n\n // set a single directory where the config files are stored\n$smarty->setConfigDir('./config');\n\n// set multiple directories where config files are stored\n$smarty->setConfigDir(['./config', './config_2', './config_3']);\n\n// add directory where config files are stored to the current list of dirs\n$smarty->addConfigDir('./config_1');\n\n// add multiple directories to the current list of dirs\n$smarty->addConfigDir([\n './config_2',\n './config_3',\n]);\n\n// chaining of method calls\n$smarty->setConfigDir('./config')\n ->addConfigDir('./config_1', 'one')\n ->addConfigDir('./config_2', 'two');\n\n// get all directories where config files are stored\n$config_dirs = $smarty->getConfigDir();\nvar_dump($config_dirs); // array\n\n// get directory identified by key\n$config_dir = $smarty->getConfigDir(0);\nvar_dump($config_dir); // string\nEven though Smarty runs templates as native PHP for maximum speed, it still needs to execute the PHP code on each call. If your data doesn't change all that often, you may be able to speed up your application even more by using output caching.
Output caching can be a tricky subject, so we devoted an entire section to caching. Be sure to read that if you want to use caching.
By default, Smarty stores caches to PHP-files in a subdirectory named ./cache.
If you need to change this, you can use setCacheDir(). Use getCacheDir() to retrieve the configured path.
<?php\n\n// set another path to store caches\n$smarty->setCacheDir('/data/caches');\n\n// get directory where cached templates are stored\n$cacheDir = $smarty->getCacheDir();\nBy default, Smarty does not escape anything you render in your templates. If you use Smarty to render a HTML-page, this means that you will have to make sure that you do not render any characters that have a special meaning in HTML, such as &, < and >, or apply the escape modifier to anything you want to render.
If you forget to do so, you may break your HTML page, or even create a vulnerability for attacks known as XSS or Cross Site Scripting.
Luckily, you can tell Smarty to automatically apply the escape modifier to any dynamic part of your template. It's like Smarty magically adds |escape to every variable you use on a web page.
Enable auto-escaping for HTML as follows:
$smarty->setEscapeHtml(true);\nWhen auto-escaping is enabled, the |escape modifier's default mode (html) has no effect, to avoid double-escaping. It is possible to force it with the force mode. Other modes (htmlall, url, urlpathinfo, quotes, javascript) may be used with the result you might expect, without double-escaping.
Even when auto-escaping is enabled, you might want to display the content of a variable without escaping it. To do so, use the |raw modifier.
Examples (with auto-escaping enabled):
{* these three statements are identical *}\n{$myVar}\n{$myVar|escape}\n{$myVar|escape:'html'}\n\n{* no double-escaping on these statements *}\n{$var|escape:'htmlall'}\n{$myVar|escape:'url'}\n{$myVar|escape:'urlpathinfo'}\n{$myVar|escape:'quotes'}\n{$myVar|escape:'javascript'}\n\n{* no escaping at all *}\n{$myVar|raw}\n\n{* force double-escaping *}\n{$myVar|escape:'force'}\nBy default, Smarty tests to see if the current template has changed since the last time it was compiled. If it has changed, it recompiles that template.
Once an application is put into production, this compile-check step is usually no longer needed and the extra checks can significantly hurt performance. Be sure to disable compile checking on production for maximum performance.
<?php\n$smarty->setCompileCheck(\\Smarty\\Smarty::COMPILECHECK_OFF);\nIf caching is enabled and compile-check is enabled, then the cache files will get regenerated if an involved template file or config file was updated.
There are a variety of encodings for textual data, ISO-8859-1 (Latin1) and UTF-8 being the most popular. Unless you change \\Smarty\\Smarty::$_CHARSET, Smarty recognizes UTF-8 as the internal charset.
Note
ISO-8859-1 has been PHP\\'s default internal charset since the beginning. Unicode has been evolving since 1991. Since then, it has become the one charset to conquer them all, as it is capable of encoding most of the known characters even across different character systems (latin, cyrillic, japanese, ...). UTF-8 is unicode\\'s most used encoding, as it allows referencing the thousands of character with the smallest size overhead possible.
Since unicode and UTF-8 are very widespread nowadays, their use is strongly encouraged.
Note
Smarty\\'s internals and core plugins are truly UTF-8 compatible since Smarty 3.1.
<?php\n\n// use japanese character encoding\nmb_internal_charset('EUC-JP');\n\n\\Smarty\\Smarty::$_CHARSET = 'EUC-JP';\n$smarty = new \\Smarty\\Smarty();\nInheritance allows you to define base templates that can be extended by child templates. Extending means that the child template can override all or some of the named block areas in the base template.
When you render the child template, the result will as if you rendered the base template, with only the block(s) that you have overridden in the child templates differing.
The inheritance tree can be as deep as you want, meaning you can extend a file that extends another one that extends another one and so on.
The child templates can not define any content besides what's inside {block} tags they override. Anything outside of {block} tags will be removed.
Template inheritance is a compile time process which creates a single compiled template file. Compared to corresponding solutions based on subtemplates included with the {include} tag it does have much better performance when rendering.
First, create a base template with one or more blocks. Then, create a child template. The child template must have an {extends} tag on its first line.
The child template can redefine one or more blocks defined in the base template.
See below for a simple example.
layout.tpl (base)
<html>\n <head>\n <title>{block name=title}Default Page Title{/block}</title>\n {block name=head}{/block}\n </head>\n <body>\n {block name=body}{/block}\n </body>\n</html>\nmyproject.tpl (child)
{extends file='layout.tpl'}\n{block name=head}\n <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n <script src=\"/js/mypage.js\"></script>\n{/block}\nmypage.tpl (grandchild)
{extends file='myproject.tpl'}\n{block name=title}My Page Title{/block}\n{block name=head}\n <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n <script src=\"/js/mypage.js\"></script>\n{/block}\n{block name=body}My HTML Page Body goes here{/block}\nTo render the above, you would use:
<?php\n$smarty->display('mypage.tpl');\nThe resulting output is:
<html>\n <head>\n <title>My Page Title</title>\n <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n <script src=\"/js/mypage.js\"></script>\n </head>\n <body>\n My HTML Page Body goes here\n </body>\n</html>\nNote
When compile-check is enabled, all files in the inheritance tree are checked for modifications upon each invocation. You may want to disable compile-check on production servers for this reason.
Note
If you have a subtemplate which is included with {include} and it contains {block} areas it works only if the {include} itself is called from within a surrounding {block}. In the final parent template you may need a dummy {block} for it.
The content of {block} tags from child and parent templates can be merged by the append or prepend {block} tag option flags and {$smarty.block.parent} or {$smarty.block.child} placeholders.
Instead of using {extends} tags in the template files you can define the inheritance tree in your PHP script by using the extends: resource type.
The code below will return same result as the example above.
<?php\n$smarty->display('extends:layout.tpl|myproject.tpl|mypage.tpl'); \nAs explained in basics, you can use $smarty->fetch() or $smarty->display() to render a template directly.
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('homepage.tpl');\n\n// or\n\n$output = $smarty->fetch('homepage.tpl');\nWhen you use display(), Smarty renders the template to the standard output stream. fetch() returns the output instead of echoing it.
The example above uses simple filenames to load the template. Smarty also supports loading templates from resources.
"},{"location":"api/rendering/#creating-a-template-object","title":"Creating a template object","text":"You can also create a template object which later can be prepared first, and rendered later. This can be useful, for example if you plan to re-use several templates.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// create template object with its private variable scope\n$tpl = $smarty->createTemplate('index.tpl');\n\n// assign a variable (available only to this template)\n$tpl->assign('title', 'My Homepage!');\n\n// display the template\n$tpl->display();\nMore on assigning variables in using data in templates.
"},{"location":"api/rendering/#testing-if-a-template-exists","title":"Testing if a template exists","text":"You can use templateExists() to check whether a template exists before you attempt to use it.
It accepts either a path to the template on the filesystem or a resource string specifying the template.
This example uses $_GET['page'] to {include} a content template. If the template does not exist then an error page is displayed instead. First, the page_container.tpl
<html>\n <head>\n <title>{$title|escape}</title>\n </head>\n <body>\n {* include middle content page *}\n {include file=$content_template}\n </body>\n</html>\nAnd the php script:
<?php\n\n// set the filename eg index.inc.tpl\n$mid_template = $_GET['page'].'.inc.tpl';\n\nif (!$smarty->templateExists($mid_template)){\n $mid_template = 'page_not_found.tpl';\n}\n$smarty->assign('content_template', $mid_template);\n\n$smarty->display('page_container.tpl');\nSo far in our examples, we have used simple filenames or paths when loading a template.
For example, to load a template file called homepage.tpl, from the filesystem, you could write:
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('homepage.tpl');\nThe filesystem is the default resource. Templates, however, may come from a variety of sources. When you render a template, or when you include a template from within another template, you supply a resource type, followed by : and the appropriate path and template name.
If a resource is not explicitly given, the default resource type is assumed. The resource type for the filesystem is file, which means that the previous example can be rewritten as follows:
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('file:homepage.tpl');\nThe file resource pulls templates source files from the directories specified using Smarty::setTemplateDir() (see Configuring Smarty).
setTemplateDir accepts a single path, but can also ben called with an array of paths. In that case, the list of directories is traversed in the order they appear in the array. The first template found is the one to process.
Smarty 3.1 introduced the bracket-syntax for specifying an element from Smarty::setTemplateDir(). This allows websites employing multiple sets of templates better control over which template to access.
The bracket-syntax can be used as follows:
<?php\n\n// setup template directories\n$smarty->setTemplateDir([\n './templates', // element: 0, index: 0\n './templates_2', // element: 1, index: 1\n '10' => 'templates_10', // element: 2, index: '10'\n 'foo' => 'templates_foo', // element: 3, index: 'foo'\n]);\n\n/*\n assume the template structure\n ./templates/foo.tpl\n ./templates_2/foo.tpl\n ./templates_2/bar.tpl\n ./templates_10/foo.tpl\n ./templates_10/bar.tpl\n ./templates_foo/foo.tpl\n*/\n\n// regular access\n$smarty->display('file:foo.tpl'); \n// will load ./templates/foo.tpl\n\n// using numeric index\n$smarty->display('file:[1]foo.tpl'); \n// will load ./templates_2/foo.tpl\n\n// using numeric string index\n$smarty->display('file:[10]foo.tpl'); \n// will load ./templates_10/foo.tpl\n\n// using string index\n$smarty->display('file:[foo]foo.tpl'); \n// will load ./templates_foo/foo.tpl\n\n// using \"unknown\" numeric index (using element number)\n$smarty->display('file:[2]foo.tpl'); \n// will load ./templates_10/foo.tpl\nAnd, from within a Smarty template:
{include file=\"file:foo.tpl\"}\n{* will load ./templates/foo.tpl *}\n\n{include file=\"file:[1]foo.tpl\"}\n{* will load ./templates_2/foo.tpl *}\n\n{include file=\"file:[foo]foo.tpl\"}\n{* will load ./templates_foo/foo.tpl *}\nTemplates outside the specified template directories require the file: template resource type, followed by the absolute path to the template (with leading slash).
<?php\n$smarty->display('file:/export/templates/index.tpl');\n$smarty->display('file:/path/to/my/templates/menu.tpl');\n````\n\nAnd from within a Smarty template:\n```smarty\n{include file='file:/usr/local/share/templates/navigation.tpl'}\nNote
With Security enabled, access to templates outside of the specified templates directories is not allowed unless you whitelist those directories.
If you are running on Windows, file paths usually include a drive letter (such as C:) at the beginning of the pathname. Be sure to use file: in the path to avoid namespace conflicts and get the desired results.
<?php\n$smarty->display('file:C:/export/templates/index.tpl');\n$smarty->display('file:F:/path/to/my/templates/menu.tpl');\nAnd from within Smarty template:
{include file='file:D:/usr/local/share/templates/navigation.tpl'}\nIf the file resource cannot find the requested template, it will check if there is a default template handler to call. By default, there is none, and Smarty will return an error, but you can register a default template handler calling Smarty::registerDefaultTemplateHandler with any callable.
<?php\n\n$smarty->registerDefaultTemplateHandler([$this, 'handleMissingTemplate']);\n\n// ...\n\npublic function handleMissingTemplate($type, $name, &$content, &$modified, Smarty $smarty) {\n if (/* ... */) {\n // return corrected filepath\n return \"/tmp/some/foobar.tpl\";\n } elseif (/* ... */) {\n // return a template directly\n $content = \"the template source\";\n $modified = time();\n return true;\n } else {\n // tell smarty that we failed\n return false;\n }\n}\nSmarty can render templates from a string by using the string: or eval: resource.
The string: resource behaves much the same as a template file. The template source is compiled from a string and stores the compiled template code for later reuse. Each unique template string will create a new compiled template file. If your template strings are accessed frequently, this is a good choice. If you have frequently changing template strings (or strings with low reuse value), the eval: resource may be a better choice, as it doesn\\'t save compiled templates to disk.
The eval: resource evaluates the template source every time a page is rendered. This is a good choice for strings with low reuse value. If the same string is accessed frequently, the string: resource may be a better choice.
Note
With a string: resource type, each unique string generates a compiled file. Smarty cannot detect a string that has changed, and therefore will generate a new compiled file for each unique string. It is important to choose the correct resource so that you do not fill your disk space with wasted compiled strings.
<?php\n$smarty->assign('foo', 'value');\n$template_string = 'display {$foo} here';\n$smarty->display('string:' . $template_string); // compiles for later reuse\n$smarty->display('eval:' . $template_string); // compiles every time\n{include file=\"string:$template_string\"} {* compiles for later reuse *}\n{include file=\"eval:$template_string\"} {* compiles every time *}\nBoth string: and eval: resources may be encoded with urlencode() or base64_encode(). This is not necessary for the usual use of string: and eval:, but is required when using either of them in conjunction with the extends resource.
<?php\n $smarty->assign('foo','value');\n $template_string_urlencode = urlencode('display {$foo} here');\n $template_string_base64 = base64_encode('display {$foo} here');\n $smarty->display('eval:urlencode:' . $template_string_urlencode); // will decode string using urldecode()\n $smarty->display('eval:base64:' . $template_string_base64); // will decode string using base64_decode()\nFrom within a Smarty template:
{include file=\"string:urlencode:$template_string_urlencode\"} {* will decode string using urldecode() *}\n {include file=\"eval:base64:$template_string_base64\"} {* will decode string using base64_decode() *}\nThe extends: resource is used to define child/parent relationships. For details see section of Template inheritance.
Note
Using the extends resource is usually not necessary. If you have a choice, it is normally more flexible and intuitive to handle inheritance chains from within the templates using the {extends} tag.
When string: and eval: templates are used, make sure they are properly url or base64 encoded.
The templates within an inheritance chain are not compiled separately. Only a single compiled template will be generated. (If an eval: resource is found within an inheritance chain, its \"don't save a compile file\" property is superseded by the extends: resource.)
Example:
<?php\n$smarty->display('extends:parent.tpl|child.tpl|grandchild.tpl'); \n\n// inheritance from multiple template sources\n$smarty->display('extends:db:parent.tpl|file:child.tpl|grandchild.tpl|eval:{block name=\"fooBazVar_\"}hello world{/block}'); \nSmarty allow you to use PHP streams as a template resource. Smarty will first look for a registered template resource. If nothing is found, it will check if a PHP stream is available. If a stream is available, Smarty will use it to fetch the template.
For example,
<?php\nstream_wrapper_register('myresource', MyResourceStream::class);\n$smarty->display('myresource:bar.tpl');\nOr, from within a template:
{include file=\"myresource:bar.tpl\"}\nYou can create a class that extends Smarty\\Resource\\CustomPlugin to add your own resource type, for example to load template from a database.
For example:
<?php\nclass HelloWorldResource extends Smarty\\Resource\\CustomPlugin {\n\n protected function fetch($name, &$source, &$mtime) {\n $source = '{$x=\"hello world\"}{$x}'; // load your template here based on $name\n $mtime = time();\n }\n\n}\n\n// ..\n\n$smarty->registerResource('helloworld', new HelloWorldResource());\nIf a Resource's templates should not be run through the Smarty compiler, the Custom Resource may extend \\Smarty\\Resource\\UncompiledPlugin. The Resource Handler must then implement the function renderUncompiled(\\Smarty\\Template $_template). $_template is a reference to the current template and contains all assigned variables which the implementor can access via $_template->getSmarty()->getTemplateVars(). These Resources simply echo their rendered content to the output stream. The rendered output will be output-cached if the Smarty instance was configured accordingly. See src/Resource/PhpPlugin.php for an example.
If the Resource's compiled templates should not be cached on disk, the Custom Resource may extend \\Smarty\\Resource\\RecompiledPlugin. These Resources are compiled every time they are accessed. This may be an expensive overhead. See src/Resource/StringEval.php for an example.
The default resource type is file. If you want to change it, use Smarty::setDefaultResourceType.
The following example will change the default resource type to mysql:
<?php\n$smarty->setDefaultResourceType('mysql');\nSecurity is good for situations when you have untrusted parties editing the templates, and you want to reduce the risk of system security compromises through the template language.
The settings of the security policy are defined by overriding public properties of an instance of the \\Smarty\\Security class. These are the possible settings:
$secure_dir is an array of template directories that are considered secure. A directory configured using $smarty->setTemplateDir() is considered secure implicitly. The default is an empty array.$trusted_uri is an array of regular expressions matching URIs that are considered trusted. This security directive is used by {fetch} and {html_image}. URIs passed to these functions are reduced to {$PROTOCOL}://{$HOSTNAME} to allow simple regular expressions (without having to deal with edge cases like authentication-tokens).The expression '#https?://.*smarty.net$#i' would allow accessing the following URIs:
- `http://smarty.net/foo`\n- `http://smarty.net/foo`\n- `http://www.smarty.net/foo`\n- `http://smarty.net/foo`\n- `https://foo.bar.www.smarty.net/foo/bla?blubb=1`\nbut deny access to these URIs:
- `http://smarty.com/foo` (not matching top-level domain \\\"com\\\")\n- `ftp://www.smarty.net/foo` (not matching protocol \\\"ftp\\\")\n- `http://www.smarty.net.otherdomain.com/foo` (not matching end of\n domain \\\"smarty.net\\\")\n$static_classes is an array of classes that are considered trusted. The default is an empty array which allows access to all static classes. To disable access to all static classes set $static_classes = null.
$streams is an array of streams that are considered trusted and can be used from within template. To disable access to all streams set $streams = null. An empty array ( $streams = [] ) will allow all streams. The default is array('file').
$allowed_modifiers is an array of (registered / autoloaded) modifiers that should be accessible to the template. If this array is non-empty, only the herein listed modifiers may be used. This is a whitelist.
$disabled_modifiers is an array of (registered / autoloaded) modifiers that may not be accessible to the template.
$allowed_tags is a boolean flag which controls if constants can function-, block and filter plugins that should be accessible to the template. If this array is non-empty, only the herein listed modifiers may be used. This is a whitelist.
$disabled_tags is an array of (registered / autoloaded) function-, block and filter plugins that may not be accessible to the template.
$allow_constants is a boolean flag which controls if constants can be accessed by the template. The default is \"true\".
$allow_super_globals is a boolean flag which controls if the PHP super globals can be accessed by the template. The default is \"true\".
If security is enabled, no private methods, functions or properties of static classes or assigned objects can be accessed (beginning with '_') by the template.
To customize the security policy settings you can extend the \\Smarty\\Security class or create an instance of it.
<?php\n\nuse Smarty\\Smarty;\n\nclass My_Security_Policy extends \\Smarty\\Security {\n public $allow_constants = false;\n}\n\n$smarty = new Smarty();\n\n$smarty->enableSecurity('My_Security_Policy');\n<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n\n$my_security_policy = new \\Smarty\\Security($smarty);\n$my_security_policy->allow_constants = false;\n\n$smarty->enableSecurity($my_security_policy);\n<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n\n// enable default security\n$smarty->enableSecurity();\nNote
Most security policy settings are only checked when the template gets compiled. For that reason you should delete all cached and compiled template files when you change your security settings.
"},{"location":"api/caching/basics/","title":"Caching","text":"Caching is used to speed up the rendering of a template by saving and re-using the output.
If a cached version of the call is available, that is displayed instead of regenerating the output. Caching can speed things up tremendously, especially templates with longer computation times.
Since templates can include or extend other templates, one cache file could conceivably be made up of several template files, config files, etc.
** Note **
Since templates are dynamic, it is important to be careful what you are caching and for how long. For instance, if you are displaying the front page of your website that does not change its content very often, it might work well to cache this page for an hour or more. On the other hand, if you are displaying a page with a timetable containing new information by the minute, it would not make sense to cache this page.
"},{"location":"api/caching/basics/#setting-up-caching","title":"Setting Up Caching","text":"The first thing to do is enable caching by calling Smarty::setCaching() with either \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT or \\Smarty\\Smarty::CACHING_LIFETIME_SAVED. Or with \\Smarty\\Smarty::CACHING_OFF to disable caching again.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// enable caching, using the current lifetime (see below)\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// enable caching, using the lifetime set when the cache was saved (see below)\n$smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);\n\n// disable caching\n$smarty->setCaching(Smarty::CACHING_OFF);\n\n$smarty->display('index.tpl');\nWith caching enabled, the function call to $smarty->display('index.tpl') will render the template as usual, but also saves a copy of its output. On the next call to $smarty->display('index.tpl'), the cached copy will be used instead of rendering the template again.
Note
By default, Smarty saved its caches as files in a dir called cache relative to the current directory. The default directory can be changed using $smarty->setCacheDir('/some/cache/dir'); The files are named similar to the template name. Although they end in the .php extension, they are not intended to be directly executable. Do not edit these files!
Each cached page has a limited lifetime. The default value is 3600 seconds, or one hour. After that time expires, the cache is regenerated.
You can change the lifetime as follows:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); \n// or $smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);\n\n// set the cache_lifetime to 5 minutes\n$smarty->setCacheLifetime(5 * 60);\nSetting caching to a value of \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT tells Smarty to use the current lifetime to determine if the cache has expired.
A value of \\Smarty\\Smarty::CACHING\\_LIFETIME\\_SAVED tells Smarty to use the lifetime value at the time the cache was generated. This way you can set the just before rendering a template to have granular control over when that particular cache expires.
An example:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// retain current cache lifetime for each specific display call\n$smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);\n\n// set the cache_lifetime for index.tpl to 5 minutes\n$smarty->setCacheLifetime(300);\n$smarty->display('index.tpl');\n\n// set the cache_lifetime for home.tpl to 1 hour\n$smarty->setCacheLifetime(3600);\n$smarty->display('home.tpl');\n\n// NOTE: the following $cache_lifetime setting will not work when $caching\n// is set to Smarty::CACHING_LIFETIME_SAVED.\n// The cache lifetime for home.tpl has already been set\n// to 1 hour, and will no longer respect the value of $cache_lifetime.\n// The home.tpl cache will still expire after 1 hour.\n$smarty->setCacheLifetime(30); // 30 seconds\n$smarty->display('home.tpl');\nBy default, every template file and config file that is involved with the cache file is checked for modification. If any of the files have been modified since the cache was generated, the cache is immediately regenerated.
This is a computational overhead, so for optimum performance, disable this on a production environment:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n$smarty->setCompileCheck(Smarty::COMPILECHECK_OFF);\n\n$smarty->display('index.tpl');\nSmarty's `isCached() method can be used to test if a template has a valid cache or not. If you have a cached template that requires something like a database fetch, you can use this to skip that process.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif (!$smarty->isCached('index.tpl')) {\n // No cache available, do variable assignments here.\n $smarty->assign('data', do_expensive_database_calls());\n}\n\n$smarty->display('index.tpl');\nYou can keep parts of a page dynamic (disable caching) with the {nocache}{/nocache} block function, or by using the nocache parameter for most template functions.
Let's say the whole page can be cached except for a banner that is displayed down the side of the page. By using a {nocache}{/nocache} block for the banner, you can keep this element dynamic within the cached content.
You can clear all the cache files with Smarty's clearAllCache() method, or individual cache files with the clearCache() method.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear only cache for index.tpl\n$smarty->clearCache('index.tpl');\n\n// clear out all cache files\n$smarty->clearAllCache();\n\n// clear out all cache files older than one hour\n$smarty->clearAllCache(3600);\n\n// or, clear all expired caches\n$smarty->clearAllCache(Smarty::CLEAR_EXPIRED);\nAs an alternative to using the default file-based caching mechanism, you can specify a custom cache implementation that will be used to read, write and clear cached files.
With a custom cache implementation you could replace the slow filesystem by a faster storage engine, centralize the cache to be accessible to multiple servers.
Smarty requires implementations to extend \\Smarty\\Cacheresource\\Base, but encourages you to either extend \\Smarty\\Cacheresource\\Custom or \\Smarty\\Cacheresource\\KeyValueStore.
\\Smarty\\Cacheresource\\Custom is a simple API directing all read, write, clear calls to your implementation. This API allows you to store wherever and however you deem fit. \\Smarty\\Cacheresource\\KeyValueStore allows you to turn any KeyValue-Store (like APC or Memcache) into a full-featured CacheResource implementation. Everything around deep cache-groups like \"a|b|c\" is being handled for you in a way that guarantees clearing the cache-group \"a\" will clear all nested groups as well - even though KeyValue-Stores don't allow this kind of hierarchy by nature.Custom CacheResources must be registered on runtime with Smarty\\Smarty::setCacheResource():
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setCacheResource(new My_CacheResource_Mysql());\nYou can have multiple cache files for a single call to display() or fetch().
Let's say that a call to $smarty->display('index.tpl') may have several different output contents depending on some condition, and you want separate caches for each one. You can do this by passing a $cache_id as the second parameter to the function call:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$my_cache_id = (int) $_GET['article_id'];\n\n$smarty->display('index.tpl', $my_cache_id);\nAbove, we are passing the variable $my_cache_id to display() as the $cache_id. For each unique value of $my_cache_id, a separate cache will be generated for index.tpl. In this example, article_id was passed in the URL and is used as the $cache_id.
Note
Be very cautious when passing values from a client (web browser) into Smarty or any PHP application. Although the above example of using the article_id from the URL looks handy, it could have bad consequences. The $cache_id is used to create a directory on the file system, so if the user decided to write a script that sends random article_id's at a rapid pace, this could possibly cause problems at the server level. Be sure to sanitize any data passed in before using it. In this example, you might want to check if the article_id is a valid ID in the database.
Be sure to pass the same $cache_id as the second parameter to isCached() and clearCache().
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$my_cache_id = (int) $_GET['article_id'];\n\nif (!$smarty->isCached('index.tpl', $my_cache_id)) {\n // ...\n}\n\n$smarty->display('index.tpl', $my_cache_id);\nYou can clear all caches for a particular $cache_id by passing NULL as the first parameter to clearCache().
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear all caches with \"sports\" as the $cache_id\n$smarty->clearCache(null, 'sports');\n\n$smarty->display('index.tpl', 'sports');\nIn this manner, you can \"group\" your caches together by giving them the same $cache_id.
You can do more elaborate grouping by setting up $cache_id groups. This is accomplished by separating each sub-group with a vertical bar | in the $cache_id value. You can have as many sub-groups as you like.
You can think of cache groups like a directory hierarchy. For instance, a cache group of 'a|b|c' could be thought of as the directory structure '/a/b/c/'.
clearCache(null, 'a|b|c') would be like removing the files '/a/b/c/*'. clearCache(null, 'a|b') would be like removing the files '/a/b/*'.
If you specify a template name such as clearCache('foo.tpl', 'a|b|c') then Smarty will attempt to remove '/a/b/c/foo.tpl'.
You CANNOT remove a specified template name under multiple cache groups such as '/a/b/*/foo.tpl', the cache grouping works left-to-right ONLY. You will need to group your templates under a single cache group hierarchy to be able to clear them as a group.
Cache grouping should not be confused with your template directory hierarchy, the cache grouping has no knowledge of how your templates are structured. So for example, if you have a template structure like themes/blue/index.tpl and you want to be able to clear all the cache files for the \"blue\" theme, you will need to create a cache group structure that mimics your template file structure, such as display('themes/blue/index.tpl', 'themes|blue'), then clear them with clearCache(null, 'themes|blue').
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear all caches with 'sports|basketball' as the first two cache_id groups\n$smarty->clearCache(null, 'sports|basketball');\n\n// clear all caches with \"sports\" as the first cache_id group. This would\n// include \"sports|basketball\", or \"sports|(anything)|(anything)|(anything)|...\"\n$smarty->clearCache(null, 'sports');\n\n// clear the foo.tpl cache file with \"sports|basketball\" as the cache_id\n$smarty->clearCache('foo.tpl', 'sports|basketball');\n\n$smarty->display('index.tpl', 'sports|basketball');\nBlock tags are tags of the form: {func} .. {/func}. In other words, they enclose a template block and operate on the contents of this block.
Block functions take precedence over normal tags of the same name, that is, you cannot have both custom tag {func} and block tag {func}..{/func}.
By default, your function implementation is called twice by Smarty: once for the opening tag, and once for the closing tag. (See $repeat below on how to change this.)
Only the opening tag of the block has attributes. All attributes are contained in the $params variable as an associative array. The opening tag attributes are also accessible to your function when processing the closing tag.
The value of the $content variable depends on whether your function is called for the opening or closing tag. In case of the opening tag, it will be NULL, and in case of the closing tag it will be the contents of the template block. Note that the template block will have already been processed by Smarty, so all you will receive is the template output, not the template source.
The parameter $repeat is passed by reference to the function implementation and provides a possibility for it to control how many times the block is displayed. By default $repeat is TRUE at the first call of the block function (the opening tag) and FALSE on all subsequent calls to the block function (the block's closing tag). Each time the function implementation returns with $repeat being TRUE, the contents between {func}...{/func} are evaluated and the function implementation is called again with the new block contents in the parameter $content.
Example:
<?php\n\nfunction smarty_block_translate($params, $content, \\Smarty\\Template $template, &$repeat) {\n // only output on the closing tag\n if (!$repeat){\n if (isset($content)) {\n $lang = $params['lang'];\n // do some intelligent translation thing here with $content\n return $translation;\n }\n }\n}\n\n$smarty->registerPlugin(Smarty\\Smarty::PLUGIN_BLOCK, 'translate', 'smarty_block_translate');\nThis can now be used in your templates as follows:
{translate lang='nl'}\n Quia omnis nulla omnis iusto est id et.\n{/translate}\nIn order to organize your custom tags and modifiers, you can create an Extension. In fact, most of Smarty itself is organized into two extensions:
{if}, {for} and {assign}. |escape, |nl2br and |number_format and tags such as {html_image}, {mailto} and {textformat} that are enabled by default, but not necessarily universal.** Note **
There is also the 'BCPluginsAdapter' extension, which does not add any new functionality, but wraps calls to deprecated methods such as Smarty\\Smarty::addPluginsDir() and Smarty\\Smarty::loadFilter().
In order to write your own custom extension, you must write a class that implements Smarty\\Extension\\ExtensionInterface. However, it is usually easier to extend Smarty\\Extension\\Base which provides empty implementation for each of the methods required by Smarty\\Extension\\ExtensionInterface. This allows you to only override the method(s) you need.
Example:
<?php\n\nuse Smarty\\Extension\\Base;\n\nclass MyExtension extends Base {\n\n public function getModifierCompiler(string $modifier): ?\\Smarty\\Compile\\Modifier\\ModifierCompilerInterface {\n\n switch ($modifier) {\n case 'array_escape': return new MyArrayEscapeModifierCompiler();\n case 'array_unescape': return new MyArrayUnescapeModifierCompiler();\n }\n\n return null;\n }\n}\n<?php\n\nuse Smarty\\Extension\\Base;\n\nclass MyCallablePassThroughExtension extends Base {\n\n public function getModifierCallback(string $modifierName) {\n\n if (is_callable($modifierName)) {\n return $modifierName;\n }\n\n return null;\n }\n}\nWriting an extension allows you to add a group of tags, block tags and modifiers to the Smarty language. It also allows you to register pre-, post- and output-filters in a structured way. The files in src/Extension/ in the smarty/smarty dir should give you all the information you need to start writing your own extension.
When you have written your extension, add it to a Smarty instance as follows:
<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n\n$smarty->addExtension(new MyCustomExtension());\nThis will add MyCustomExtension to the end of the extension list, meaning that you cannot override tags or modifiers from one of Smarty's default extensions.
Should you wish to insert your extension at the top of the extension list, or create a very limited Smarty version that only contains the core extension, you can use Smarty\\Smarty::setExtensions() to override the list of extensions.
<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n\n$smarty->setExtensions([\n new Smarty\\Extension\\CoreExtension(),\n new MyCustomExtension(),\n new Smarty\\Extension\\DefaultExtension(),\n]);\nBy default, Smarty is already very complete and powerful. However, you can unlock its real potential by extending Smarty.
There are various ways to extend Smarty for it to suit your needs. You can create custom tags, block tags and modifiers by registering a method as a plugin.
If this becomes too messy, you can group your custom tags, modifiers, and more into an Extension.
"},{"location":"api/extending/modifiers/","title":"Custom modifiers","text":"Modifiers are little functions that are applied to a variable in the template before it is displayed or used in some other context. Smarty comes with a bunch of modifiers, but you can easily add your own.
In order to do so, you must write a function that accepts as its first parameter the value on which the modifier is to operate. The rest of the parameters are optional, depending on what kind of operation is to be performed.
The modifier has to return the result of its processing.
For example:
<?php\n\nfunction smarty_modifier_substr($string, $offset, $length) {\n return substr($string, $offset, $length);\n}\n\n$smarty->registerPlugin(Smarty\\Smarty::PLUGIN_MODIFIER, 'substr', 'smarty_modifier_substr');\nYou can now use this in your templates as follows:
{$applicationName|substr:0:20}\nYou can add your own tags to the Smarty language.
"},{"location":"api/extending/tags/#runtime-tags","title":"Runtime tags","text":"Usually, you'll add a runtime tag. Adding a runtime tag requires you to provide a callback function that accepts two parameters:
$params: all attributes from the template as an associative array.$template: a Smarty\\Template object representing the template where tag was used.The output (return value) of the function will be substituted in place of the tag in the template.
If the function needs to assign some variables to the template or use some other Smarty-provided functionality, it can use the supplied $template object to do so.
<?php\n\nfunction smarty_tag_eightball($params, \\Smarty\\Template $template): string {\n $answers = [\n 'Yes',\n 'No',\n 'No way',\n 'Outlook not so good',\n 'Ask again soon',\n 'Maybe in your reality'\n ];\n\n $result = array_rand($answers);\n return $answers[$result];\n}\n\n$smarty->registerPlugin(Smarty\\Smarty::PLUGIN_FUNCTION, 'eightball', 'smarty_tag_eightball');\nWhich can now be used in the template as:
Question: Will we ever have time travel?\nAnswer: {eightball}.\nCompiler tags are called only during compilation of the template.
They are useful for injecting PHP code or time-sensitive static content into the template. If there is both a compiler function and a runtime tag registered under the same name, the compiler function has precedence.
The compiler function is passed two parameters: the params array which contains precompiled strings for the attribute values and the Smarty object. It's supposed to return the code to be injected into the compiled template including the surrounding PHP tags.
Example:
<?php\n\nfunction smarty_compiler_tplheader($params, Smarty $smarty) {\n return \"<?php\\necho '\" . $smarty->_current_file . \" compiled at \" . date('Y-m-d H:M'). \"';\\n?>\";\n}\n\n$smarty->registerPlugin(Smarty\\Smarty::PLUGIN_COMPILER, 'tplheader', 'smarty_compiler_tplheader');\nThis function can be called from the template as:
{* this function gets executed at compile time only *}\n{tplheader}\nThe resulting PHP code in the compiled template would be something like this:
<?php\necho 'index.tpl compiled at 2023-02-20 20:02';\nWhen a template is rendered, its output can be sent through one or more output filters.
Note This differs from prefilters and postfilters because, pre- and postfilters operate on compiled templates before they are saved to the disk, whereas output filters operate on the template output when it is executed.
Smarty will pass the template output as the first argument, and expect the function to return the result of the processing.
Output filters can be either added as part of an Extension or registered as shown below.
This will provide a rudimentary protection against spambots:
<?php\n\nfunction protect_email($tpl_output, \\Smarty\\Template\\ $template)\n{\n return preg_replace(\n '!(\\S+)@([a-zA-Z0-9\\.\\-]+\\.([a-zA-Z]{2,3}|[0-9]{1,3}))!',\n '$1%40$2', \n $tpl_output\n );\n}\n\n// register the outputfilter\n$smarty->registerFilter(\"output\", \"protect_email\");\n$smarty->display(\"index.tpl');\nTemplate postfilters are PHP functions that your templates are ran through after they are compiled.
Smarty will pass the compiled template code as the first argument, and expect the function to return the result of the processing, which must also be valid PHP code.
Prefilters can be either added as part of an Extension or registered as shown below.
<?php\n\nfunction add_header_comment($tpl_source, \\Smarty\\Template\\ $template)\n{\n return \"<?php echo \\\"<!-- Created by Smarty! -->\\n\\\"; ?>\\n\".$tpl_source;\n}\n\n// register the postfilter\n$smarty->registerFilter('post', 'add_header_comment');\n$smarty->display('index.tpl');\nThe postfilter above will make the compiled Smarty template index.tpl look like:
<!-- Created by Smarty! -->\n{* rest of template content... *}\nTemplate prefilters are PHP functions that your templates are ran through before they are compiled. This is good for preprocessing your templates to remove unwanted comments, keeping an eye on what people are putting in their templates, etc.
Smarty will pass the template source code as the first argument, and expect the function to return the resulting template source code.
Prefilters can be either added as part of an Extension or registered as shown below.
This will remove all the html comments in the template source:
<?php\n\nfunction remove_dw_comments($tpl_source, \\Smarty\\Template\\ $template)\n{\n return preg_replace(\"/<!--#.*-->/U\",'',$tpl_source);\n}\n\n// register the prefilter\n$smarty->registerFilter('pre', 'remove_dw_comments');\n$smarty->display('index.tpl');\nTemplates start to become really useful once you know how to use variables.
"},{"location":"api/variables/assigning/#basic-assigning","title":"Basic assigning","text":"Let's revisit the example from the basics section. The following script assigns a value to the 'companyName' variable and renders the template:
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->assign('companyName', 'AC & ME Corp.');\n\n$smarty->display('footer.tpl');\nfooter.tpl:
<small>Copyright {$companyName|escape}</small>\nSmarty will apply the escape modifier to the value assigned to the variable companyName and replace {$companyName|escape} with the result.
<small>Copyright AC & ME Corp.</small>\nUsing $smarty->assign() is the most common way of assigning data to templates, but there are several other methods.
Using append(), you can add data to an existing variable, usually an array.
If you append to a string value, it is converted to an array value and then appended to. You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs. If you pass the optional third parameter of TRUE, the value will be merged with the current array instead of appended.
Examples:
<?php\n// This is effectively the same as assign()\n$smarty->append('foo', 'Fred');\n// After this line, foo will now be seen as an array in the template\n$smarty->append('foo', 'Albert');\n\n$array = [1 => 'one', 2 => 'two'];\n$smarty->append('X', $array);\n$array2 = [3 => 'three', 4 => 'four'];\n// The following line will add a second element to the X array\n$smarty->append('X', $array2);\n\n// passing an associative array\n$smarty->append(['city' => 'Lincoln', 'state' => 'Nebraska']);\nWhen you use a template objects, as explained in rendering a template, you can assign data to the template objects directly instead of assigning it to Smarty. This way, you can use different sets of data for different templates.
For example:
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$tplBlue = $smarty->createTemplate('blue.tpl');\n$tplBlue->assign('name', 'The one');\n$tplBlue->display();\n\n$tplRed = $smarty->createTemplate('red.tpl');\n$tplRed->assign('name', 'Neo');\n$tplRed->display();\nFor more complex use cases, Smarty supports the concept of data objects. Data objects are containers to hold data. Data objects can be attached to templates when creating them. This allows for fine-grained re-use of data.
For example:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// create a data object\n$data = $smarty->createData();\n\n// assign variable to the data object\n$data->assign('name', 'Neo');\n\n// create template object which will use variables from the data object\n$tpl = $smarty->createTemplate('index.tpl', $data);\n\n// display the template\n$tpl->display();\nWhen re-using templates, you may need to clear data assigned in a previous run. Use clearAllAssign() to clear the values of all assigned variables on data objects, template objects or the Smarty object.
Examples:
<?php\n// assigning data to the Smarty object\n$smarty->assign('Name', 'Fred');\n// ...\n$smarty->clearAllAssign();\n\n// using a data object\n$data = $smarty->createData();\n$data->assign('name', 'Neo');\n// ...\n$data->clearAllAssign();\n\n// using a template\n$tplBlue = $smarty->createTemplate('blue.tpl');\n$tplBlue->assign('name', 'The one');\n// ...\n$tplBlue->clearAllAssign();\nNote that there it's only useful to clear assigned data if you:
If your script simply runs once and then ends, or you always assign the same variables, clearing assigned data is of no use.
"},{"location":"api/variables/config-files/","title":"Loading data from config files","text":"Instead of assigning data to templates from PHP, you can also use a config file.
"},{"location":"api/variables/config-files/#example-config-file","title":"Example config file","text":"Config files are best suited to manage template settings from one file. One example is a multi-language application. Instead of writing multiple templates to support different languages, you can write a single template file and load your language dependent strings from config files.
Example lang.en.ini:
# global variables\npageTitle = \"Main Menu\"\n\n[Customer]\npageTitle = \"Customer Info\"\n\n[Login]\npageTitle = \"Login\"\nfocus = \"username\"\nIntro = \"\"\"This is a value that spans more\n than one line. you must enclose\n it in triple quotes.\"\"\"\nValues of config file variables can be in quotes, but not necessary. You can use either single or double quotes. If you have a value that spans more than one line, enclose the entire value with triple quotes (\"\"\"). You can put comments into config files by any syntax that is not a valid config file syntax. We recommend using a # (hash) at the beginning of the line.
The example config file above has two sections. Section names are enclosed in [brackets]. Section names can be arbitrary strings not containing [ or ] symbols. The variable at the top is a global variable. Global variables are always loaded from the config file. If a particular section is loaded, then the global variables and the variables from that section are also loaded. If a variable exists both as a global and in a section, the section variable is used.
Config files are loaded into templates with the built-in template function {config_load} or by calling configLoad() from PHP:
<?php\n$smarty->configLoad('lang.en.ini');\nLoad a specific section with:
<?php\n$smarty->configLoad('lang.en.ini', 'Customer');\nNote that the global section will always be loaded.
"},{"location":"api/variables/config-files/#retrieving-config-variables-in-php","title":"Retrieving config variables in PHP","text":""},{"location":"api/variables/config-files/#loading-from-a-resource","title":"Loading from a resource","text":"Config files (or resources) are loaded by the same resource facilities as templates. That means that a config file can also be loaded from a db. See resources for more information.
"},{"location":"api/variables/config-files/#config-overwrite","title":"Config overwrite","text":"If you name two variables the same within a section, the last one will be used unless you call:
<?php\n$smarty->setConfigOverwrite(false);\nSee also {config_load}, $default_config_handler_func, getConfigVars(), clearConfig() and configLoad()
Smarty allows access to PHP objects through the templates.
Note
When you assign/register objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.
There are two ways to access them.
"},{"location":"api/variables/objects/#assign-the-object","title":"Assign the object","text":"You can assign objects to a template and access them much like any other assigned variable.
Example:
<?php\n// the object\n\nclass My_Object {\n public function meth1($params, $smarty_obj) {\n return 'this is my meth1';\n }\n}\n\n// We can also assign objects. assign_by_ref when possible.\n$smarty->assign('myobj', new My_Object());\n\n$smarty->display('index.tpl');\nAnd here's how to access your object in index.tpl:
{$myobj->meth1('foo',$bar)}\nRegisterd objects use a different template syntax. Also, a registered object can be restricted to certain methods or properties. However, a registered object cannot be looped over or assigned in arrays of objects, etc.
If security is enabled, no private methods or functions can be accessed (beginning with '_'). If a method and property of the same name exist, the method will be used.
You can restrict the methods and properties that can be accessed by listing them in an array as the third registration parameter.
By default, parameters passed to objects through the templates are passed the same way custom tags get them. An associative array is passed as the first parameter, and the smarty object as the second. If you want the parameters passed one at a time for each argument like traditional object parameter passing, set the fourth registration parameter to FALSE.
The optional fifth parameter has only effect with format being TRUE and contains a list of methods that should be treated as blocks. That means these methods have a closing tag in the template ({foobar->meth2}...{/foobar->meth2}) and the parameters to the methods have the same synopsis as the parameters for block tags: They get the four parameters $params, $content, $smarty and &$repeat and they also behave like block tags.
<?php\n// the object\n\nclass My_Object {\n function meth1($params, $smarty_obj) {\n return 'this is my meth1';\n }\n}\n\n$myobj = new My_Object;\n\n// registering the object\n$smarty->registerObject('foobar', $myobj);\n\n// if we want to restrict access to certain methods or properties, list them\n$smarty->registerObject('foobar', $myobj, array('meth1','meth2','prop1'));\n\n// if you want to use the traditional object parameter format, pass a boolean of false\n$smarty->registerObject('foobar', $myobj, null, false);\n\n$smarty->display('index.tpl');\nAnd here's how to access your objects in index.tpl:
{* access our registered object *}\n{foobar->meth1 p1='foo' p2=$bar}\n\n{* you can also assign the output *}\n{foobar->meth1 p1='foo' p2=$bar assign='output'}\nthe output was {$output}\nYou can directly access static classes. The syntax is roughly the same as in PHP.
Note
Direct access to PHP classes is not recommended. This ties the underlying application code structure directly to the presentation, and also complicates template syntax. It is recommended to register plugins which insulate templates from PHP classes/objects. Use at your own discretion.
"},{"location":"api/variables/static-class-methods/#examples","title":"Examples","text":"class constant BAR
{assign var=foo value=myclass::BAR}\nmethod result
{assign var=foo value=myclass::method()} \nmethod chaining
{assign var=foo value=myclass::method1()->method2}\nproperty bar of class myclass
{assign var=foo value=myclass::$bar} \nusing Smarty variable bar as class name
{assign var=foo value=$bar::method}\nYou can also use streams to call variables. {$foo:bar} will use the foo://bar stream to get the template variable.
Using a PHP stream for a template variable resource from within a template.
{$foo:bar}\nNB. Support for using streams to call variables is deprecated since Smarty v5.1 and will be removed in a future version.
See also Template Resources
There may be times when you want to print a default value for an empty variable instead of printing nothing, such as printing so that html table backgrounds work properly. Many would use an {if} statement to handle this, but there is a shorthand way with Smarty, using the default variable modifier.
Note
\"Undefined variable\" errors will show an E_NOTICE if not disabled in PHP's error_reporting() level or Smarty's $error_reporting property and a variable had not been assigned to Smarty.
{* the long way *}\n {if $title eq ''}\n \n {else}\n {$title}\n {/if}\n\n {* the short way *}\n {$title|default:' '}\nSee also default modifier and default variable handling.
If a variable is used frequently throughout your templates, applying the default modifier every time it is mentioned can get a bit ugly. You can remedy this by assigning the variable its default value with the {assign} function.
{* do this somewhere at the top of your template *}\n{assign var='title' value=$title|default:'no title'}\n\n{* if $title was empty, it now contains the value \"no title\" when you use it *}\n{$title}\nSee also default modifier and blank variable handling.
When the majority of your templates use the same headers and footers, it is common to split those out into their own templates and {include} them. But what if the header needs to have a different title, depending on what page you are coming from? You can pass the title to the header as an attribute when it is included.
mainpage.tpl - When the main page is drawn, the title of \"Main Page\" is passed to the header.tpl, and will subsequently be used as the title.
{include file='header.tpl' title='Main Page'}\n{* template body goes here *}\n{include file='footer.tpl'}\narchives.tpl - When the archives page is drawn, the title will be \"Archives\". Notice in the archive example, we are using a variable from the archives_page.conf file instead of a hard coded variable.
{config_load file='archive_page.conf'}\n\n{include file='header.tpl' title=#archivePageTitle#}\n{* template body goes here *}\n{include file='footer.tpl'}\nheader.tpl - Notice that \"Smarty News\" is printed if the $title variable is not set, using the default variable modifier.
<html>\n <head>\n <title>{$title|default:'Smarty News'}</title>\n </head>\n<body>\nfooter.tpl
</body>\n</html>\nAs a rule of thumb, always pass dates to Smarty as timestamps. This allows template designers to use the date_format modifier for full control over date formatting, and also makes it easy to compare dates if necessary.
{$startDate|date_format}\nThis will output:
Jan 4, 2009\n{$startDate|date_format:\"%Y/%m/%d\"}\nThis will output:
2009/01/04\nDates can be compared in the template by timestamps with:
{if $order_date < $invoice_date}\n ...do something..\n{/if}\nWhen using {html_select_date} in a template, the programmer will most likely want to convert the output from the form back into timestamp format. Here is a function to help you with that.
<?php\n\n// this assumes your form elements are named\n// startDate_Day, startDate_Month, startDate_Year\n\n$startDate = makeTimeStamp($startDate_Year, $startDate_Month, $startDate_Day);\n\nfunction makeTimeStamp($year='', $month='', $day='')\n{\n if(empty($year)) {\n $year = strftime('%Y');\n }\n if(empty($month)) {\n $month = strftime('%m');\n }\n if(empty($day)) {\n $day = strftime('%d');\n }\n\n return mktime(0, 0, 0, $month, $day, $year);\n}\nSee also {html_select_date}, {html_select_time}, date_format and $smarty.now,
Traditionally, programming templates into your applications goes as follows: First, you accumulate your variables within your PHP application, (maybe with database queries.) Then, you instantiate your Smarty object, assign() the variables and display() the template. So lets say for example we have a stock ticker on our template. We would collect the stock data in our application, then assign these variables in the template and display it. Now wouldn't it be nice if you could add this stock ticker to any application by merely including the template, and not worry about fetching the data up front?
You can do this by writing a custom plugin for fetching the content and assigning it to a template variable.
function.load_ticker.php
<?php\n\n// setup our function for fetching stock data\nfunction fetch_ticker($symbol)\n{\n // put logic here that fetches $ticker_info\n // from some ticker resource\n return $ticker_info;\n}\n\nfunction smarty_function_load_ticker($params, $smarty)\n{\n // call the function\n $ticker_info = fetch_ticker($params['symbol']);\n\n // assign template variable\n $smarty->assign($params['assign'], $ticker_info);\n}\nindex.tpl
{load_ticker symbol='SMARTY' assign='ticker'}\n\nStock Name: {$ticker.name} Stock Price: {$ticker.price}\nSee also: {include}.
Do you ever wonder how your email address gets on so many spam mailing lists? One way spammers collect email addresses is from web pages. To help combat this problem, you can make your email address show up in scrambled javascript in the HTML source, yet it it will look and work correctly in the browser. This is done with the {mailto} plugin.
<div id=\"contact\">Send inquiries to\n{mailto address=$EmailAddress encode='javascript' subject='Hello'}\n</div>\nNote
This method isn\\'t 100% foolproof. A spammer could conceivably program his e-mail collector to decode these values, but not likely.... hopefully..yet ... wheres that quantum computer :-?.
See also escape modifier and {mailto}.
Smarty can catch many errors such as missing tag attributes or malformed variable names. If this happens, you will see an error similar to the following:
Warning: Smarty: [in index.tpl line 4]: syntax error: unknown tag - '%blah'\n in /path/to/smarty/Smarty.class.php on line 1041\n\nFatal error: Smarty: [in index.tpl line 28]: syntax error: missing section name\n in /path/to/smarty/Smarty.class.php on line 1041\nSmarty shows you the template name, the line number and the error. After that, the error consists of the actual line number in the Smarty class that the error occurred.
There are certain errors that Smarty cannot catch, such as missing close tags. These types of errors usually end up in PHP compile-time parsing errors.
Parse error: parse error in /path/to/smarty/templates_c/index.tpl.php on line 75
When you encounter a PHP parsing error, the error line number will correspond to the compiled PHP script, NOT the template itself. Usually you can look at the template and spot the syntax error. Here are some common things to look for: missing close tags for {if}{/if} or {section}{/section}, or syntax of logic within an {if} tag. If you can\\'t find the error, you might have to open the compiled PHP file and go to the line number to figure out where the corresponding error is in the template.
Warning: Smarty error: unable to read resource: \"index.tpl\" in...\nWarning: Smarty error: unable to read resource: \"site.conf\" in...\nThe $template_dir is incorrect, doesn't exist or the file index.tpl is not in the templates/ directory
A {config_load} function is within a template (or configLoad() has been called) and either $config_dir is incorrect, does not exist or site.conf is not in the directory.
Fatal error: Smarty error: the $compile_dir 'templates_c' does not exist,\nor is not a directory...\n$compile_diris incorrectly set, the directory does not exist, or templates_c is a file and not a directory.Fatal error: Smarty error: unable to write to $compile_dir '....\n$compile_dir is not writable by the web server. See the bottom of the installing smarty page for more about permissions.Fatal error: Smarty error: the $cache_dir 'cache' does not exist,\nor is not a directory. in /..\n$caching is enabled and either; the $cache_dir is incorrectly set, the directory does not exist, or cache/ is a file and not a directory.Fatal error: Smarty error: unable to write to $cache_dir '/...\n$caching is enabled and the $cache_dir is not writable by the web server. See the bottom of the installing smarty page for permissions.Warning: filemtime(): stat failed for /path/to/smarty/cache/3ab50a623e65185c49bf17c63c90cc56070ea85c.one.tpl.php \nin /path/to/smarty/libs/sysplugins/smarty_resource.php\n$errno as it should. If, for whatever reason, this is the desired behaviour of your custom error handler, please call muteExpectedErrors() after you've registered your custom error handler.See also debugging.
"},{"location":"designers/chapter-debugging-console/","title":"Debugging Console","text":"There is a debugging console included with Smarty. The console informs you of all the included templates, assigned variables and config file variables for the current invocation of the template. A template file named debug.tpl is included with the distribution of Smarty which controls the formatting of the console.
Set $debugging to TRUE in Smarty, and if needed set $debug_tpl to the template resource path to debug.tpl. When you load the page, a Javascript console window will pop up and give you the names of all the included templates and assigned variables for the current page.
To see the available variables for a particular template, see the {debug} template function. To disable the debugging console, set $debugging to FALSE. You can also temporarily turn on the debugging console by putting SMARTY_DEBUG in the URL if you enable this option with $debugging_ctrl.
Note
The debugging console does not work when you use the fetch() API, only when using display(). It is a set of javascript statements added to the very bottom of the generated template. If you do not like javascript, you can edit the debug.tpl template to format the output however you like. Debug data is not cached and debug.tpl info is not included in the output of the debug console.
Note
The load times of each template and config file are in seconds, or fractions thereof.
See also troubleshooting.
"},{"location":"designers/config-files/","title":"Config Files","text":"Config files are handy for designers to manage global template variables from one file. One example is template colors. Normally if you wanted to change the color scheme of an application, you would have to go through each and every template file and change the colors. With a config file, the colors can be kept in one place, and only one file needs to be updated.
# global variables\npageTitle = \"Main Menu\"\nbodyBgColor = #000000\ntableBgColor = #000000\nrowBgColor = #00ff00\n\n[Customer]\npageTitle = \"Customer Info\"\n\n[Login]\npageTitle = \"Login\"\nfocus = \"username\"\nIntro = \"\"\"This is a value that spans more\n than one line. you must enclose\n it in triple quotes.\"\"\"\n\n# hidden section\n[.Database]\nhost=my.example.com\ndb=ADDRESSBOOK\nuser=php-user\npass=foobar\nValues of config file variables can be in quotes, but not necessary. You can use either single or double quotes. If you have a value that spans more than one line, enclose the entire value with triple quotes (\"\"\"). You can put comments into config files by any syntax that is not a valid config file syntax. We recommend using a # (hash) at the beginning of the line.
The example config file above has two sections. Section names are enclosed in [brackets]. Section names can be arbitrary strings not containing [ or ] symbols. The four variables at the top are global variables, or variables not within a section. These variables are always loaded from the config file. If a particular section is loaded, then the global variables and the variables from that section are also loaded. If a variable exists both as a global and in a section, the section variable is used. If you name two variables the same within a section, the last one will be used unless $config_overwrite is disabled.
Config files are loaded into templates with the built-in template function {config_load} or the API configLoad() function.
You can hide variables or entire sections by prepending the variable name or section name with a period(.) eg [.hidden]. This is useful if your application reads the config files and gets sensitive data from them that the template engine does not need. If you have third parties doing template editing, you can be certain that they cannot read sensitive data from the config file by loading it into the template.
Config files (or resources) are loaded by the same resource facilities as templates. That means that a config file can also be loaded from a db $smarty->configLoad(\"db:my.conf\").
See also {config_load}, $config_overwrite, $default_config_handler_func, getConfigVars(), clearConfig() and configLoad()
You can apply any number of modifiers to a variable. They will be applied in the order they are combined, from left to right. They must be separated with a | (pipe) character.
<?php\n\n$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');\nwhere template is:
{$articleTitle}\n{$articleTitle|upper|spacify}\n{$articleTitle|lower|spacify|truncate}\n{$articleTitle|lower|truncate:30|spacify}\n{$articleTitle|lower|spacify|truncate:30:\". . .\"}\nThe above example will output:
Smokers are Productive, but Death Cuts Efficiency.\nS M O K E R S A R ....snip.... H C U T S E F F I C I E N C Y .\ns m o k e r s a r ....snip.... b u t d e a t h c u t s...\ns m o k e r s a r e p r o d u c t i v e , b u t . . .\ns m o k e r s a r e p. . .\nA simple Smarty template could look like this:
<h1>{$title|escape}</h1>\n<ul>\n {foreach $cities as $city}\n <li>{$city.name|escape} ({$city.population})</li>\n {foreachelse}\n <li>no cities found</li> \n {/foreach}\n</ul>\nAll Smarty template tags are enclosed within delimiters. By default these are { and }, but they can be changed.
For the examples in this manual, we will assume that you are using the default delimiters. In Smarty, all content outside of delimiters is displayed as static content, or unchanged. When Smarty encounters template tags, it attempts to interpret them, and displays the appropriate output in their place.
The basic components of the Smarty syntax are:
It is sometimes desirable or even necessary to have Smarty ignore sections it would otherwise parse. A classic example is embedding Javascript or CSS code in a template. The problem arises as those languages use the { and } characters which are also the default delimiters for Smarty.
Note
A good practice for avoiding escapement altogether is by separating your Javascript/CSS into their own files and use standard HTML methods to access them. This will also take advantage of browser script caching. When you need to embed Smarty variables/functions into your Javascript/CSS, then the following applies.
In Smarty templates, the { and } braces will be ignored so long as they are surrounded by white space. This behavior can be disabled by setting the Smarty class variable $auto_literal to false.
<script>\n // the following braces are ignored by Smarty\n // since they are surrounded by whitespace\n function foobar {\n alert('foobar!');\n }\n // this one will need literal escapement\n {literal}\n function bazzy {alert('foobar!');}\n {/literal}\n</script>\n{literal}..{/literal} blocks are used for escaping blocks of template logic. You can also escape the braces individually with {ldelim}, {rdelim} tags or {$smarty.ldelim},{$smarty.rdelim} variables.
Smarty's default delimiters { and } cleanly represent presentational content. However, if another set of delimiters suit your needs better, you can change them with Smarty's setLeftDelimiter() and setRightDelimiter() methods.
Note
Changing delimiters affects ALL template syntax and escapement. Be sure to clear out cache and compiled files if you decide to change them.
<?php\n\n$smarty->setLeftDelimiter('<!--{');\n$smarty->setRightDelimiter('}-->');\n\n$smarty->assign('foo', 'bar');\n$smarty->assign('name', 'Albert');\n$smarty->display('example.tpl');\nWhere the template is:
Welcome <!--{$name}--> to Smarty\n <script>\n var foo = <!--{$foo}-->;\n function dosomething() {\n alert(\"foo is \" + foo);\n }\n dosomething();\n</script>\nMost of the tags take attributes that specify or modify their behavior. Attributes to Smarty functions are much like HTML attributes. Static values don't have to be enclosed in quotes, but it is required for literal strings. Variables with or without modifiers may also be used, and should not be in quotes. You can even use PHP function results, plugin results and complex expressions.
Some attributes require boolean values (TRUE or FALSE). These can be specified as true and false. If an attribute has no value assigned it gets the default boolean value of true.
{include file=\"header.tpl\"}\n\n{include file=\"header.tpl\" nocache} // is equivalent to nocache=true\n\n{include file=\"header.tpl\" attrib_name=\"attrib value\"}\n\n{include file=$includeFile}\n\n{include file=#includeFile# title=\"My Title\"}\n\n{assign var=foo value={counter}} // plugin result\n\n{assign var=foo value=substr($bar,2,5)} // PHP function result\n\n{assign var=foo value=$bar|strlen} // using modifier\n\n{assign var=foo value=$buh+$bar|strlen} // more complex expression\n\n{html_select_date display_days=true}\n\n{mailto address=\"smarty@example.com\"}\n\n<select name=\"company_id\">\n {html_options options=$companies selected=$company_id}\n</select>\nNote
Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.
"},{"location":"designers/language-basic-syntax/language-syntax-comments/","title":"Comments","text":"Template comments are surrounded by asterisks, and that is surrounded by the delimiter tags like so:
"},{"location":"designers/language-basic-syntax/language-syntax-comments/#examples","title":"Examples","text":"{* this is a comment *}\nSmarty comments are NOT displayed in the final output of the template, unlike <!-- HTML comments -->. These are useful for making internal notes in the templates which no one will see ;-)
{* I am a Smarty comment, I don't exist in the compiled output *}\n<html>\n <head>\n <title>{$title}</title>\n </head>\n<body>\n\n {* another single line smarty comment *}\n <!-- HTML comment that is sent to the browser -->\n\n {* this multiline smarty\n comment is\n not sent to browser\n *}\n\n {*********************************************************\n Multi line comment block with credits block\n @ author: bg@example.com\n @ maintainer: support@example.com\n @ para: var that sets block style\n @ css: the style output\n **********************************************************}\n\n {* The header file with the main logo and stuff *}\n {include file='header.tpl'}\n\n\n {* Dev note: the $includeFile var is assigned in foo.php script *}\n <!-- Displays main content block -->\n {include file=$includeFile}\n\n {* this <select> block is redundant *}\n {*\n <select name=\"company\">\n {html_options options=$vals selected=$selected_id}\n </select>\n *}\n\n <!-- Show header from affiliate is disabled -->\n {* $affiliate|upper *}\n\n {* you cannot nest comments *}\n {*\n <select name=\"company\">\n {* <option value=\"0\">-- none -- </option> *}\n {html_options options=$vals selected=$selected_id}\n </select>\n *}\n\n </body>\n</html>\nVarious basic operators can be applied directly to variable values.
"},{"location":"designers/language-basic-syntax/language-syntax-operators/#examples","title":"Examples","text":"{$foo + 1}\n\n{$foo * $bar}\n\n{$foo->bar - $bar[1] * $baz->foo->bar() -3 * 7}\n\n{if ($foo + $bar.test % $baz * 134232 + 10 + $b + 10)}\n ...\n{/if}\n\n{$foo = $foo + $bar}\nNote
Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.
"},{"location":"designers/language-basic-syntax/language-syntax-operators/#list","title":"List","text":"The following is a list of recognized operators, which must be separated from surrounding elements by spaces. Note that items listed in [brackets] are optional. PHP equivalents are shown where applicable.
Operator Alternates Syntax Example Meaning PHP Equivalent == eq $a eq $b equals == != ne, neq $a neq $b not equals != > gt $a gt $b greater than > < lt $a lt $b less than < >= gte, ge $a ge $b greater than or equal >= <= lte, le $a le $b less than or equal <= === $a === 0 check for identity === ! not not $a negation (unary) ! % mod $a mod $b modulo % is [not] div by $a is not div by 4 divisible by $a % $b == 0 is [not] even $a is not even [not] an even number (unary) $a % 2 == 0 is [not] even by $a is not even by $b grouping level [not] even ($a / $b) % 2 == 0 is [not] odd $a is not odd [not] an odd number (unary) $a % 2 != 0 is [not] odd by $a is not odd by $b [not] an odd grouping ($a / $b) % 2 != 0 is in $a is in $b exists in array in_array($a, $b) is [not] in $a is not in $b does not exist in array !in_array($a, $b)"},{"location":"designers/language-basic-syntax/language-syntax-operators/#ternary","title":"Ternary","text":"You can use the ?: (or ternary) operator to test one expression and present the value of the second or third expression, based on the result of the test.
In other words:
{$test ? \"OK\" : \"FAIL\"}\n$test is set to true, and in FAIL otherwise. There is also a shorthand ?: operator:
{$myVar ?: \"empty\"}\n$myVar is not set or set to something that evaluates to false, such as an empty string. If $myVar is set to something that evaluates to true, the value of $myVar is returned. So, the following will return 'hello': {$myVar=\"hello\"}\n{$myVar ?: \"empty\"}\nIf \"something that evaluates to false\" is to broad a test for you, you can use the ?? (or null coalescing) operator to trigger only if the tested value is undefined or set to null.
{$myVar ?? \"empty\"}\n$myVar is not set or set to null. If $myVar is set to something that evaluates to anything else, the value of $myVar is returned. So, the following will return an empty string (''): {$myVar=\"\"}\n{$myVar ?: \"this is not shown\"}\nSmarty will recognize assigned variables embedded in \"double quotes\" so long as the variable name contains only numbers, letters and under_scores. See naming for more detail.
With any other characters, for example a period(.) or $object->reference, then the variable must be surrounded by `backticks`.
In addition, Smarty does allow embedded Smarty tags in double-quoted strings. This is useful if you want to include variables with modifiers, plugin or PHP function results.
{func var=\"test $foo test\"} // sees $foo\n{func var=\"test $foo_bar test\"} // sees $foo_bar\n{func var=\"test `$foo[0]` test\"} // sees $foo[0]\n{func var=\"test `$foo[bar]` test\"} // sees $foo[bar]\n{func var=\"test $foo.bar test\"} // sees $foo (not $foo.bar)\n{func var=\"test `$foo.bar` test\"} // sees $foo.bar\n{func var=\"test `$foo.bar` test\"|escape} // modifiers outside quotes!\n{func var=\"test {$foo|escape} test\"} // modifiers inside quotes!\n{func var=\"test {time()} test\"} // PHP function result\n{func var=\"test {counter} test\"} // plugin result\n{func var=\"variable foo is {if !$foo}not {/if} defined\"} // Smarty block function\n\n{* will replace $tpl_name with value *}\n{include file=\"subdir/$tpl_name.tpl\"}\n\n{* does NOT replace $tpl_name *}\n{include file='subdir/$tpl_name.tpl'} // vars require double quotes!\n\n{* must have backticks as it contains a dot \".\" *}\n{cycle values=\"one,two,`$smarty.config.myval`\"}\n\n{* must have backticks as it contains a dot \".\" *}\n{include file=\"`$module.contact`.tpl\"}\n\n{* can use variable with dot syntax *}\n{include file=\"`$module.$view`.tpl\"}\nNote
Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.
See also escape.
Every Smarty tag either prints a variable or invokes some sort of function. These are processed and displayed by enclosing the function and its attributes within delimiters like so: {funcname attr1=\"val1\" attr2=\"val2\"}.
{config_load file=\"colors.conf\"}\n\n{include file=\"header.tpl\"}\n\n{if $logged_in}\n Welcome, <span style=\"color:{#fontColor#}\">{$name}!</span>\n{else}\n hi, {$name}\n{/if}\n\n{include file=\"footer.tpl\"}\nBoth built-in functions and custom functions have the same syntax within templates.
Built-in functions are the inner workings of Smarty, such as {if}, {section} and {strip}. There should be no need to change or modify them.
Custom tags are additional tags implemented via plugins. They can be modified to your liking, or you can create new ones. {html_options} is an example of a custom function.
See also registerPlugin()
Template variables start with the $dollar sign. They can contain numbers, letters and underscores, much like a PHP variable. You can reference arrays by index numerically or non-numerically. Also reference object properties and methods.
Config file variables are an exception to the \\$dollar syntax and are instead referenced with surrounding #hashmarks#, or via the $smarty.config variable.
{$foo} <-- displaying a simple variable (non array/object)\n{$foo[4]} <-- display the 5th element of a zero-indexed array\n{$foo.bar} <-- display the \"bar\" key value of an array, similar to PHP $foo['bar']\n{$foo.$bar} <-- display variable key value of an array, similar to PHP $foo[$bar]\n{$foo->bar} <-- display the object property \"bar\"\n{$foo->bar()} <-- display the return value of object method \"bar\"\n{#foo#} <-- display the config file variable \"foo\"\n{$smarty.config.foo} <-- synonym for {#foo#}\n{$foo[bar]} <-- syntax only valid in a section loop, see {section}\n{assign var=foo value='baa'}{$foo} <-- displays \"baa\", see {assign}\n\nMany other combinations are allowed\n\n{$foo.bar.baz}\n{$foo.$bar.$baz}\n{$foo[4].baz}\n{$foo[4].$baz}\n{$foo.bar.baz[4]}\n{$foo->bar($baz,2,$bar)} <-- passing parameters\n{\"foo\"} <-- static values are allowed\n\n{* display the server variable \"SERVER_NAME\" ($_SERVER['SERVER_NAME'])*}\n{$smarty.server.SERVER_NAME}\n\nMath and embedding tags:\n\n{$x+$y} // will output the sum of x and y.\n{assign var=foo value=$x+$y} // in attributes \n{$foo[$x+3]} // as array index\n{$foo={counter}+3} // tags within tags\n{$foo=\"this is message {counter}\"} // tags within double quoted strings\n\nDefining Arrays:\n\n{assign var=foo value=[1,2,3]}\n{assign var=foo value=['y'=>'yellow','b'=>'blue']}\n{assign var=foo value=[1,[9,8],3]} // can be nested\n\nShort variable assignment:\n\n{$foo=$bar+2}\n{$foo = strlen($bar)} // function in assignment\n{$foo = myfunct( ($x+$y)*3 )} // as function parameter \n{$foo.bar=1} // assign to specific array element\n{$foo.bar.baz=1} \n{$foo[]=1} // appending to an array\n\nSmarty \"dot\" syntax (note: embedded {} are used to address ambiguities):\n\n{$foo.a.b.c} => $foo['a']['b']['c'] \n{$foo.a.$b.c} => $foo['a'][$b]['c'] // with variable index\n{$foo.a.{$b+4}.c} => $foo['a'][$b+4]['c'] // with expression as index\n{$foo.a.{$b.c}} => $foo['a'][$b['c']] // with nested index\n\nPHP-like syntax, alternative to \"dot\" syntax:\n\n{$foo[1]} // normal access\n{$foo['bar']}\n{$foo['bar'][1]}\n{$foo[$x+$x]} // index may contain any expression\n{$foo[$bar[1]]} // nested index\n{$foo[section_name]} // smarty {section} access, not array access!\n\nVariable variables:\n\n$foo // normal variable\n$foo_{$bar} // variable name containing other variable \n$foo_{$x+$y} // variable name containing expressions \n$foo_{$bar}_buh_{$blar} // variable name with multiple segments\n{$foo_{$x}} // will output the variable $foo_1 if $x has a value of 1.\n\nObject chaining:\n\n{$object->method1($x)->method2($y)}\nNote
Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.
Request variables such as $_GET, $_SESSION, etc are available via the reserved $smarty variable.
See also $smarty, config variables {assign} and assign().
Smarty comes with several built-in functions. These built-in functions are the integral part of the smarty template engine. They are compiled into corresponding inline PHP code for maximum performance.
You cannot create your own custom tags with the same name; and you should not need to modify the built-in functions.
A few of these functions have an assign attribute which collects the result the function to a named template variable instead of being output; much like the {assign} function.
{append} is used for creating or appending template variable arrays during the execution of a template.
Note
Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion.
"},{"location":"designers/language-builtin-functions/language-function-append/#examples","title":"Examples","text":"{append var='name' value='Bob' index='first'}\n{append var='name' value='Meyer' index='last'}\n// or \n{append 'name' 'Bob' index='first'} {* short-hand *}\n{append 'name' 'Meyer' index='last'} {* short-hand *}\n\nThe first name is {$name.first}.<br>\nThe last name is {$name.last}.\nThe above example will output:
The first name is Bob.\nThe last name is Meyer.\nSee also append() and getTemplateVars().
{assign} or {$var=...} is used for assigning template variables during the execution of a template.
Note
Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion.
"},{"location":"designers/language-builtin-functions/language-function-assign/#examples","title":"Examples","text":"{assign var=\"name\" value=\"Bob\"} {* or *}\n{assign \"name\" \"Bob\"} {* short-hand, or *}\n{$name='Bob'}\n\nThe value of $name is {$name}.\nThe above example will output:
The value of $name is Bob.\n{assign var=\"name\" value=\"Bob\" nocache} {* or *}\n{assign \"name\" \"Bob\" nocache} {* short-hand, or *}\n{$name='Bob' nocache}\n\nThe value of $name is {$name}.\nThe value of $name is Bob.\n{assign var=running_total value=$running_total+$some_array[$row].some_value} {* or *}\n{$running_total=$running_total+$some_array[row].some_value}\nVariables assigned in the included template will be seen in the including template.
{include file=\"sub_template.tpl\"}\n\n{* display variable assigned in sub_template *}\n{$foo}<br>\nThe template above includes the example sub_template.tpl below:
{* foo will be known also in the including template *}\n{assign var=\"foo\" value=\"something\" scope=parent}\n{$foo=\"something\" scope=parent}\n\n{* bar is assigned only local in the including template *}\n{assign var=\"bar\" value=\"value\"} {* or *}\n{$var=\"value\"}\nYou can assign a variable to root of the current root tree. The variable is seen by all templates using the same root tree.
{assign var=foo value=\"bar\" scope=\"root\"}\nA global variable is seen by all templates.
{assign var=foo value=\"bar\" scope=\"global\"} {* or *}\n{assign \"foo\" \"bar\" scope=\"global\"} {* short-hand, or *}\n{$foo=\"bar\" scope=\"global\"}\nFor more information on variable scope, please read the page on variable scopes.
To access {assign} variables from a php script use getTemplateVars(). Here's the template that creates the variable $foo.
{assign var=\"foo\" value=\"Smarty\"} {* or *}\n{$foo=\"Smarty\"}\nThe template variables are only available after/during template execution as in the following script.
<?php\n\n// this will output nothing as the template has not been executed\necho $smarty->getTemplateVars('foo');\n\n// fetch the template to a variable\n$whole_page = $smarty->fetch('index.tpl');\n\n// this will output 'smarty' as the template has been executed\necho $smarty->getTemplateVars('foo');\n\n$smarty->assign('foo','Even smarter');\n\n// this will output 'Even smarter'\necho $smarty->getTemplateVars('foo');\nThe following functions can also optionally assign template variables: {capture}, {include}, {counter}, {cycle}, {eval}, {fetch}, {math} and {textformat}.
See also {append}, assign() and getTemplateVars().
{block} is used to define a named area of template source for template inheritance. For details see section of Template Inheritance.
The {block} template source area of a child template will replace the corresponding areas in the parent template(s).
Optionally {block} areas of child and parent templates can be merged into each other. You can append or prepend the parent {block} content by using the append or prepend option flag with the child's {block} definition. With {$smarty.block.parent} the {block} content of the parent template can be inserted at any location of the child {block} content. {$smarty.block.child} inserts the {block} content of the child template at any location of the parent {block}.
{blocks}'s can be nested.
Note
The assign attribute only works on the block that actually gets executed, so you may need to add it to each child block as well.
"},{"location":"designers/language-builtin-functions/language-function-block/#option-flags-in-child-templates-only","title":"Option Flags (in child templates only):","text":"Name Description append The{block} content will be appended to the content of the parent template {block} prepend The {block} content will be prepended to the content of the parent template {block} hide Ignore the block content if no child block of same name is existing. nocache Disables caching of the {block} content"},{"location":"designers/language-builtin-functions/language-function-block/#examples","title":"Examples","text":"parent.tpl
<html>\n <head>\n <title>{block name=\"title\"}Default Title{/block}</title>\n <title>{block \"title\"}Default Title{/block}</title> {* short-hand *}\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\"}\n Page Title\n {/block}\nThe result would look like
<html>\n <head>\n <title>Page Title</title>\n </head>\n </html>\nparent.tpl
<html>\n <head>\n <title>{block name=\"title\"}Title - {/block}</title>\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\" append}\n Page Title\n {/block}\nThe result would look like
<html>\n <head>\n <title>Title - Page Title</title>\n </head>\n </html>\nparent.tpl
<html>\n <head>\n <title>{block name=\"title\"} is my title{/block}</title>\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\" prepend}\n Page Title\n {/block}\nThe result would look like
<html>\n <head>\n <title>Page title is my titel</title>\n </head>\n </html>\nparent.tpl
<html>\n <head>\n <title>{block name=\"title\"}The {$smarty.block.child} was inserted here{/block}</title>\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\"}\n Child Title\n {/block}\nThe result would look like
<html>\n <head>\n <title>The Child Title was inserted here</title>\n </head>\n </html>\nparent.tpl
<html>\n <head>\n <title>{block name=\"title\"}Parent Title{/block}</title>\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\"}\n You will see now - {$smarty.block.parent} - here\n {/block}\nThe result would look like
<html>\n <head>\n <title>You will see now - Parent Title - here</title>\n </head>\n </html>\nSee also Template Inheritance, $smarty.block.parent, $smarty.block.child, and {extends}
{call} is used to call a template function defined by the {function} tag just like a plugin function.
Note
Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The {call} tag must be used to call a template function defined externally from the given template. Otherwise you can directly use the function as {funcname ...} in the template.
The {call} tag must have the name attribute which contains the name of the template function.
Values for variables can be passed to the template function as attributes.
{* define the function *}\n {function name=menu level=0}\n <ul class=\"level{$level}\">\n {foreach $data as $entry}\n {if is_array($entry)}\n <li>{$entry@key}</li>\n {call name=menu data=$entry level=$level+1}\n {else}\n <li>{$entry}</li>\n {/if}\n {/foreach}\n </ul>\n {/function}\n\n {* create an array to demonstrate *}\n {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>\n ['item3-3-1','item3-3-2']],'item4']}\n\n {* run the array through the function *}\n {call name=menu data=$menu}\n {call menu data=$menu} {* short-hand *}\nWill generate the following output
* item1\n * item2\n * item3\n o item3-1\n o item3-2\n o item3-3\n + item3-3-1\n + item3-3-2\n * item4\nSee also {function}.
{capture} is used to collect the output of the template between the tags into a variable instead of displaying it. Any content between {capture name='foo'} and {/capture} is collected into the variable specified in the name attribute.
The captured content can be used in the template from the variable $smarty.capture.foo where \"foo\" is the value passed in the name attribute. If you do not supply the name attribute, then \"default\" will be used as the name ie $smarty.capture.default.
{capture}'s can be nested.
{* we don't want to print a div tag unless content is displayed *}\n{capture name=\"banner\"}\n{capture \"banner\"} {* short-hand *}\n {include file=\"get_banner.tpl\"}\n{/capture}\n\n{if $smarty.capture.banner ne \"\"}\n<div id=\"banner\">{$smarty.capture.banner}</div>\n{/if}\nThis example demonstrates the capture function.
{capture name=some_content assign=popText}\n{capture some_content assign=popText} {* short-hand *}\nThe server is {$my_server_name|upper} at {$my_server_addr}<br>\nYour ip is {$my_ip}.\n{/capture}\n<a href=\"#\">{$popText}</a>\nThis example also demonstrates how multiple calls of capture can be used to create an array with captured content.
{capture append=\"foo\"}hello{/capture}I say just {capture append=\"foo\"}world{/capture}\n{foreach $foo as $text}{$text} {/foreach}\nThe above example will output:
I say just hello world\nSee also $smarty.capture, {eval}, {fetch}, fetch() and {assign}.
{config_load} is used for loading config #variables# from a configuration file into the template.
The example.conf file.
#this is config file comment\n\n# global variables\npageTitle = \"Main Menu\"\nbodyBgColor = #000000\ntableBgColor = #000000\nrowBgColor = #00ff00\n\n#customer variables section\n[Customer]\npageTitle = \"Customer Info\"\nand the template
{config_load file=\"example.conf\"}\n{config_load \"example.conf\"} {* short-hand *}\n\n<html>\n <title>{#pageTitle#|default:\"No title\"}</title>\n <body bgcolor=\"{#bodyBgColor#}\">\n <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n <tr bgcolor=\"{#rowBgColor#}\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nConfig Files may also contain sections. You can load variables from within a section with the added attribute section. Note that global config variables are always loaded along with section variables, and same-named section variables overwrite the globals.
Note
Config file sections and the built-in template function called {section} have nothing to do with each other, they just happen to share a common naming convention.
{config_load file='example.conf' section='Customer'}\n{config_load 'example.conf' 'Customer'} {* short-hand *}\n\n<html>\n <title>{#pageTitle#}</title>\n <body bgcolor=\"{#bodyBgColor#}\">\n <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n <tr bgcolor=\"{#rowBgColor#}\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nSee $config_overwrite to create arrays of config file variables.
See also the config files page, config variables page, $config_dir, getConfigVars() and configLoad().
{debug} dumps the debug console to the page. This works regardless of the debug settings in the php script. Since this gets executed at runtime, this is only able to show the assigned variables; not the templates that are in use. However, you can see all the currently available variables within the scope of a template.
If caching is enabled and a page is loaded from cache {debug} does show only the variables which assigned for the cached page.
In order to see also the variables which have been locally assigned within the template it does make sense to place the {debug} tag at the end of the template.
See also the debugging console page.
"},{"location":"designers/language-builtin-functions/language-function-extends/","title":"{extends}","text":"{extends} tags are used in child templates in template inheritance for extending parent templates. For details see section of Template Inheritance.
The {extends} tag must be on the first line of the template.
If a child template extends a parent template with the {extends} tag it may contain only {block} tags. Any other template content is ignored.
Use the syntax for template resources to extend files outside the $template_dir directory.
Note
When extending a variable parent like {extends file=$parent_file}, make sure you include $parent_file in the $compile_id. Otherwise, Smarty cannot distinguish between different $parent_files.
{extends file='parent.tpl'}\n{extends 'parent.tpl'} {* short-hand *}\nSee also Template Inheritance and {block}.
The {for}{forelse} tag is used to create simple loops. The following different formats are supported:
{for $var=$start to $end} simple loop with step size of 1.
{for $var=$start to $end step $step} loop with individual step size.
{forelse} is executed when the loop is not iterated.
{for} loop"},{"location":"designers/language-builtin-functions/language-function-for/#examples","title":"Examples","text":"<ul>\n {for $foo=1 to 3}\n <li>{$foo}</li>\n {/for}\n</ul>\nThe above example will output:
<ul>\n <li>1</li>\n <li>2</li>\n <li>3</li>\n</ul>\n<?php\n$smarty->assign('to',10);\n<ul>\n {for $foo=3 to $to max=3}\n <li>{$foo}</li>\n {/for}\n</ul>\nThe above example will output:
<ul>\n <li>3</li>\n <li>4</li>\n <li>5</li>\n</ul>\n<?php\n$smarty->assign('start',10);\n$smarty->assign('to',5);\n<ul>\n {for $foo=$start to $to}\n <li>{$foo}</li>\n {forelse}\n no iteration\n {/for}\n</ul>\nThe above example will output:
no iteration\nSee also {foreach}, {section} and {while}
{foreach} is used for looping over arrays of data. {foreach} has a simpler and cleaner syntax than the {section} loop, and can also loop over associative arrays.
{foreach} loop"},{"location":"designers/language-builtin-functions/language-function-foreach/#examples","title":"Examples","text":"{foreach $arrayvar as $itemvar}\n {$itemvar|escape}\n{/foreach}\n\n{foreach $arrayvar as $keyvar=>$itemvar}\n {$keyvar}: {$itemvar|escape}\n{/foreach}\nNote
This foreach syntax does not accept any named attributes. This syntax is new to Smarty 3, however the Smarty 2.x syntax {foreach from=$myarray key=\"mykey\" item=\"myitem\"} is still supported.
{foreach} loops can be nested.
The array variable, usually an array of values, determines the number of times {foreach} will loop. You can also pass an integer for arbitrary loops.
{foreachelse} is executed when there are no values in the array variable.
{foreach} properties are @index, @iteration, @first, @last, @show, @total.
{foreach} constructs are {break}, {continue}.
Instead of specifying the key variable you can access the current key of the loop item by {$item@key} (see examples below).
Note
The $var@property syntax is new to Smarty 3, however when using the Smarty 2 {foreach from=$myarray key=\"mykey\" item=\"myitem\"} style syntax, the $smarty.foreach.name.property syntax is still supported.
Note
Although you can retrieve the array key with the syntax {foreach $myArray as $myKey => $myValue}, the key is always available as $myValue@key within the foreach loop.
<?php\n$arr = array('red', 'green', 'blue');\n$smarty->assign('myColors', $arr);\nTemplate to output $myColors in an un-ordered list
<ul>\n {foreach $myColors as $color}\n <li>{$color}</li>\n {/foreach}\n</ul>\nThe above example will output:
<ul>\n <li>red</li>\n <li>green</li>\n <li>blue</li>\n</ul>\n<?php\n$people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com');\n$smarty->assign('myPeople', $people);\nTemplate to output $myArray as key/value pairs.
<ul>\n {foreach $myPeople as $value}\n <li>{$value@key}: {$value}</li>\n {/foreach}\n</ul>\nThe above example will output:
<ul>\n <li>fname: John</li>\n <li>lname: Doe</li>\n <li>email: j.doe@example.com</li>\n</ul>\nAssign an array to Smarty, the key contains the key for each looped value.
<?php\n $smarty->assign(\n 'contacts', \n [\n ['phone' => '555-555-1234', 'fax' => '555-555-5678', 'cell' => '555-555-0357'],\n ['phone' => '800-555-4444', 'fax' => '800-555-3333', 'cell' => '800-555-2222'],\n ]\n );\nThe template to output $contact.
{* key always available as a property *}\n{foreach $contacts as $contact}\n {foreach $contact as $value}\n {$value@key}: {$value}\n {/foreach}\n{/foreach}\n\n{* accessing key the PHP syntax alternate *}\n{foreach $contacts as $contact}\n {foreach $contact as $key => $value}\n {$key}: {$value}\n {/foreach}\n{/foreach}\nEither of the above examples will output:
phone: 555-555-1234\n fax: 555-555-5678\n cell: 555-555-0357\n phone: 800-555-4444\n fax: 800-555-3333\n cell: 800-555-2222\nA database (PDO) example of looping over search results. This example is looping over a PHP iterator instead of an array().
<?php \n use Smarty\\Smarty;\n\n $smarty = new Smarty; \n\n $dsn = 'mysql:host=localhost;dbname=test'; \n $login = 'test'; \n $passwd = 'test'; \n\n // setting PDO to use buffered queries in mysql is \n // important if you plan on using multiple result cursors \n // in the template. \n\n $db = new PDO($dsn, $login, $passwd, array( \n PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true)); \n\n $res = $db->prepare(\"select * from users\"); \n $res->execute(); \n $res->setFetchMode(PDO::FETCH_LAZY); \n\n // assign to smarty \n $smarty->assign('res',$res); \n\n $smarty->display('index.tpl');?>\n{foreach $res as $r} \n {$r.id} \n {$r.name}\n{foreachelse}\n .. no results .. \n{/foreach}\nThe above is assuming the results contain the columns named id and name.
What is the advantage of an iterator vs. looping over a plain old array? With an array, all the results are accumulated into memory before being looped. With an iterator, each result is loaded/released within the loop. This saves processing time and memory, especially for very large result sets.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#index","title":"@index","text":"index contains the current array index, starting with zero.
{* output empty row on the 4th iteration (when index is 3) *}\n<table>\n {foreach $items as $i}\n {if $i@index eq 3}\n {* put empty table row *}\n <tr><td>nbsp;</td></tr>\n {/if}\n <tr><td>{$i.label}</td></tr>\n {/foreach}\n</table>\niteration contains the current loop iteration and always starts at one, unlike index. It is incremented by one on each iteration.
The \"is div by\" operator can be used to detect a specific iteration. Here we bold-face the name every 4th iteration.
{foreach $myNames as $name}\n {if $name@iteration is div by 4}\n <b>{$name}</b>\n {/if}\n {$name}\n{/foreach}\nThe \"is even by\" and \"is odd by\" operators can be used to alternate something every so many iterations. Choosing between even or odd rotates which one starts. Here we switch the font color every 3rd iteration.
{foreach $myNames as $name}\n {if $name@index is even by 3}\n <span style=\"color: #000\">{$name}</span>\n {else}\n <span style=\"color: #eee\">{$name}</span>\n {/if}\n {/foreach}\nThis will output something similar to this:
<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n...\nfirst is TRUE if the current {foreach} iteration is the initial one. Here we display a table header row on the first iteration.
{* show table header at first iteration *}\n<table>\n {foreach $items as $i}\n {if $i@first}\n <tr>\n <th>key</td>\n <th>name</td>\n </tr>\n {/if}\n <tr>\n <td>{$i@key}</td>\n <td>{$i.name}</td>\n </tr>\n {/foreach}\n</table>\nlast is set to TRUE if the current {foreach} iteration is the final one. Here we display a horizontal rule on the last iteration.
{* Add horizontal rule at end of list *}\n{foreach $items as $item}\n <a href=\"#{$item.id}\">{$item.name}</a>{if $item@last}<hr>{else},{/if}\n{foreachelse}\n ... no items to loop ...\n{/foreach}\nThe show show property can be used after the execution of a {foreach} loop to detect if data has been displayed or not. show is a boolean value.
<ul>\n {foreach $myArray as $name}\n <li>{$name}</li>\n {/foreach}\n</ul>\n{if $name@show} do something here if the array contained data {/if}\ntotal contains the number of iterations that this {foreach} will loop. This can be used inside or after the {foreach}.
{* show number of rows at end *}\n{foreach $items as $item}\n {$item.name}<hr/>\n {if $item@last}\n <div id=\"total\">{$item@total} items</div>\n {/if}\n{foreachelse}\n ... no items to loop ...\n{/foreach}\nSee also {section}, {for} and {while}
{break} aborts the iteration of the array
{$data = [1,2,3,4,5]}\n {foreach $data as $value}\n {if $value == 3}\n {* abort iterating the array *}\n {break}\n {/if}\n {$value}\n {/foreach}\n {*\n prints: 1 2\n *}\n{continue} leaves the current iteration and begins with the next iteration.
{$data = [1,2,3,4,5]}\n {foreach $data as $value}\n {if $value == 3}\n {* skip this iteration *}\n {continue}\n {/if}\n {$value}\n {/foreach}\n {*\n prints: 1 2 4 5\n *}\n{function} is used to create functions within a template and call them just like a plugin function. Instead of writing a plugin that generates presentational content, keeping it in the template is often a more manageable choice. It also simplifies data traversal, such as deeply nested menus.
Note
Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The {call} tag must be used to call a template function defined externally from the given template. Otherwise, you can directly use the function as {funcname ...} in the template.
The {function} tag must have the name attribute which contains the name of the template function. A tag with this name can be used to call the template function.
Default values for variables can be passed to the template function as attributes. Like in PHP function declarations you can only use scalar values as default. The default values can be overwritten when the template function is being called.
You can use all variables from the calling template inside the template function. Changes to variables or new created variables inside the template function have local scope and are not visible inside the calling template after the template function is executed.
Note
You can pass any number of parameter to the template function when it is called. The parameter variables must not be declared in the {funcname ...} tag unless you what to use default values. Default values must be scalar and can not be variable. Variables must be passed when the template is called.
{* define the function *}\n{function name=menu level=0}\n{function menu level=0} {* short-hand *}\n <ul class=\"level{$level}\">\n {foreach $data as $entry}\n {if is_array($entry)}\n <li>{$entry@key}</li>\n {menu data=$entry level=$level+1}\n {else}\n <li>{$entry}</li>\n {/if}\n {/foreach}\n </ul>\n{/function}\n\n{* create an array to demonstrate *}\n{$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>\n['item3-3-1','item3-3-2']],'item4']}\n\n{* run the array through the function *}\n{menu data=$menu}\nWill generate the following output
* item1\n* item2\n* item3\n o item3-1\n o item3-2\n o item3-3\n + item3-3-1\n + item3-3-2\n* item4\nSee also {call}
{if} statements in Smarty have much the same flexibility as PHP if statements, with a few added features for the template engine. Every {if} must be paired with a matching {/if}. {else} and {elseif} are also permitted. All operators are recognized, such as ==, ||, or, &&, and, etc and you can use modifiers as functions, such as is_array().
{if $name eq 'Fred'}\n Welcome Sir.\n{elseif $name eq 'Wilma'}\n Welcome Ma'am.\n{else}\n Welcome, whatever you are.\n{/if}\n\n{* an example with \"or\" logic *}\n{if $name eq 'Fred' or $name eq 'Wilma'}\n ...\n{/if}\n\n{* same as above *}\n{if $name == 'Fred' || $name == 'Wilma'}\n ...\n{/if}\n\n\n{* parenthesis are allowed *}\n{if ( $amount < 0 or $amount > 1000 ) and $volume >= #minVolAmt#}\n ...\n{/if}\n\n\n{* you can also embed php function calls *}\n{if count($var) gt 0}\n ...\n{/if}\n\n{* check for array. *}\n{if is_array($foo) }\n .....\n{/if}\n\n{* check for not null. *}\n{if isset($foo) }\n .....\n{/if}\n\n\n{* test if values are even or odd *}\n{if $var is even}\n ...\n{/if}\n{if $var is odd}\n ...\n{/if}\n{if $var is not odd}\n ...\n{/if}\n\n\n{* test if var is divisible by 4 *}\n{if $var is div by 4}\n ...\n{/if}\n\n\n{*\n test if var is even, grouped by two. i.e.,\n 0=even, 1=even, 2=odd, 3=odd, 4=even, 5=even, etc.\n*}\n{if $var is even by 2}\n ...\n{/if}\n\n{* 0=even, 1=even, 2=even, 3=odd, 4=odd, 5=odd, etc. *}\n{if $var is even by 3}\n ...\n{/if}\n\n{if isset($name) && $name == 'Blog'}\n {* do something *}\n{elseif $name == $foo}\n {* do something *}\n{/if}\n\n{if is_array($foo) && count($foo) > 0}\n {* do a foreach loop *}\n{/if}\n{include} tags are used for including other templates in the current template. Any variables available in the current template are also available within the included template.
The {include} tag must have the file attribute which contains the template resource path.
Setting the optional assign attribute specifies the template variable that the output of {include} is assigned to, instead of being displayed. Similar to {assign}.
Variables can be passed to included templates as attributes. Any variables explicitly passed to an included template are only available within the scope of the included file. Attribute variables override current template variables, in the case when they are named the same.
You can use all variables from the including template inside the included template. But changes to variables or new created variables inside the included template have local scope and are not visible inside the including template after the {include} statement. This default behaviour can be changed for all variables assigned in the included template by using the scope attribute at the {include} statement or for individual variables by using the scope attribute at the {assign} statement. The later is useful to return values from the included template to the including template.
Use the syntax for template resources to {include} files outside of the $template_dir directory.
<html>\n <head>\n <title>{$title}</title>\n </head>\n <body>\n {include file='page_header.tpl'}\n\n {* body of template goes here, the $tpl_name variable\n is replaced with a value eg 'contact.tpl'\n *}\n {include file=\"$tpl_name.tpl\"}\n\n {* using shortform file attribute *}\n {include 'page_footer.tpl'}\n </body>\n</html>\n{include 'links.tpl' title='Newest links' links=$link_array}\n{* body of template goes here *}\n{include 'footer.tpl' foo='bar'}\nThe template above includes the example links.tpl below
<div id=\"box\">\n <h3>{$title}</h3>\n <ul>\n {foreach from=$links item=l}\n .. do stuff ...\n {/foreach}\n </ul>\n</div>\n{include 'sub_template.tpl' scope=parent}\n...\n{* display variables assigned in sub_template *}\n{$foo}<br>\n{$bar}<br>\n...\nThe template above includes the example sub_template.tpl below
...\n{assign var=foo value='something'}\n{assign var=bar value='value'}\n...\nThe included template will not be cached.
{include 'sub_template.tpl' nocache}\n...\nIn this example included template will be cached with an individual cache lifetime of 500 seconds.
{include 'sub_template.tpl' cache_lifetime=500}\n...\nIn this example included template will be cached independent of the global caching setting.
{include 'sub_template.tpl' caching}\n...\nThis example assigns the contents of nav.tpl to the $navbar variable, which is then output at both the top and bottom of the page.
<body>\n {include 'nav.tpl' assign=navbar}\n {include 'header.tpl' title='Smarty is cool'}\n {$navbar}\n {* body of template goes here *}\n {$navbar}\n {include 'footer.tpl'}\n</body>\nThis example includes another template relative to the directory of the current template.
{include 'template-in-a-template_dir-directory.tpl'}\n{include './template-in-same-directory.tpl'}\n{include '../template-in-parent-directory.tpl'}\n{* absolute filepath *}\n{include file='/usr/local/include/templates/header.tpl'}\n\n{* absolute filepath (same thing) *}\n{include file='file:/usr/local/include/templates/header.tpl'}\n\n{* windows absolute filepath (MUST use \"file:\" prefix) *}\n{include file='file:C:/www/pub/templates/header.tpl'}\n\n{* include from template resource named \"db\" *}\n{include file='db:header.tpl'}\n\n{* include a $variable template - eg $module = 'contacts' *}\n{include file=\"$module.tpl\"}\n\n{* wont work as its single quotes ie no variable substitution *}\n{include file='$module.tpl'}\n\n{* include a multi $variable template - eg amber/links.view.tpl *}\n{include file=\"$style_dir/$module.$view.tpl\"}\nSee also template resources and componentized templates.
"},{"location":"designers/language-builtin-functions/language-function-ldelim/","title":"{ldelim}, {rdelim}","text":"{ldelim} and {rdelim} are used for escaping template delimiters, by default { and }. You can also use {literal}{/literal} to escape blocks of text eg Javascript or CSS. See also the complementary {$smarty.ldelim}.
{* this will print literal delimiters out of the template *}\n\n{ldelim}funcname{rdelim} is how functions look in Smarty!\nThe above example will output:
{funcname} is how functions look in Smarty!\nAnother example with some Javascript
<script>\nfunction foo() {ldelim}\n ... code ...\n{rdelim}\n</script>\nwill output
<script>\nfunction foo() {\n .... code ...\n}\n</script>\n<script>\n function myJsFunction(){ldelim}\n alert(\"The server name\\n{$smarty.server.SERVER_NAME|escape:javascript}\\n{$smarty.server.SERVER_ADDR|escape:javascript}\");\n {rdelim}\n</script>\n<a href=\"javascript:myJsFunction()\">Click here for Server Info</a>\nSee also {literal} and escaping Smarty parsing.
{literal} tags allow a block of data to be taken literally. This is typically used around Javascript or stylesheet blocks where {curly braces} would interfere with the template delimiter syntax. Anything within {literal}{/literal} tags is not interpreted, but displayed as-is. If you need template tags embedded in a {literal} block, consider using {ldelim}{rdelim} to escape the individual delimiters instead.
Note
{literal}{/literal} tags are normally not necessary, as Smarty ignores delimiters that are surrounded by whitespace. Be sure your javascript and CSS curly braces are surrounded by whitespace. This is new behavior to Smarty 3.
<script>\n // the following braces are ignored by Smarty\n // since they are surrounded by whitespace\n function myFoo {\n alert('Foo!');\n }\n // this one will need literal escapement\n {literal}\n function myBar {alert('Bar!');}\n {/literal}\n</script>\nSee also {ldelim} {rdelim} and the escaping Smarty parsing page.
{nocache} is used to disable caching of a template section. Every {nocache} must be paired with a matching {/nocache}.
Note
Be sure any variables used within a non-cached section are also assigned from PHP when the page is loaded from the cache.
Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\nThe above code will output the current date on a cached page.
See also the caching section.
"},{"location":"designers/language-builtin-functions/language-function-section/","title":"{section}, {sectionelse}","text":"A {section} is for looping over sequentially indexed arrays of data, unlike {foreach} which is used to loop over a single associative array. Every {section} tag must be paired with a closing {/section} tag.
Note
The {foreach} loop can do everything a {section} loop can do, and has a simpler and easier syntax. It is usually preferred over the {section} loop.
Note
{section} loops cannot loop over associative arrays, they must be numerically indexed, and sequential (0,1,2,...). For associative arrays, use the {foreach} loop.
{section} loop Required attributes are name and loop.
The name of the {section} can be anything you like, made up of letters, numbers and underscores, like PHP variables.
{section}'s can be nested, and the nested {section} names must be unique from each other.
The loop attribute, usually an array of values, determines the number of times the {section} will loop. You can also pass an integer as the loop value.
When printing a variable within a {section}, the {section} name must be given next to variable name within [brackets].
{sectionelse} is executed when there are no values in the loop variable.
A {section} also has its own variables that handle {section} properties. These properties are accessible as: {$smarty.section.name.property} where \"name\" is the attribute name.
{section} properties are index, index_prev, index_next, iteration, first, last, rownum, loop, show, total.
assign() an array to Smarty
<?php\n$data = [1000, 1001, 1002];\n$smarty->assign('custid', $data);\nThe template that outputs the array
{* this example will print out all the values of the $custid array *}\n{section name=customer loop=$custid}\n{section customer $custid} {* short-hand *}\n id: {$custid[customer]}<br />\n{/section}\n<hr />\n{* print out all the values of the $custid array reversed *}\n{section name=foo loop=$custid step=-1}\n{section foo $custid step=-1} {* short-hand *}\n {$custid[foo]}<br />\n{/section}\nThe above example will output:
id: 1000<br />\nid: 1001<br />\nid: 1002<br />\n<hr />\nid: 1002<br />\nid: 1001<br />\nid: 1000<br />\n{section name=foo start=10 loop=20 step=2}\n {$smarty.section.foo.index}\n{/section}\n<hr />\n{section name=bar loop=21 max=6 step=-2}\n {$smarty.section.bar.index}\n{/section}\nThe above example will output:
10 12 14 16 18\n<hr />\n20 18 16 14 12 10\nThe name of the {section} can be anything you like, see PHP variables. It is used to reference the data within the {section}.
{section name=anything loop=$myArray}\n {$myArray[anything].foo}\n {$name[anything]}\n {$address[anything].bar}\n{/section}\nThis is an example of printing an associative array of data with a {section}. Following is the php script to assign the $contacts array to Smarty.
<?php\n$data = [\n ['name' => 'John Smith', 'home' => '555-555-5555',\n 'cell' => '666-555-5555', 'email' => 'john@myexample.com'],\n ['name' => 'Jack Jones', 'home' => '777-555-5555',\n 'cell' => '888-555-5555', 'email' => 'jack@myexample.com'],\n ['name' => 'Jane Munson', 'home' => '000-555-5555',\n 'cell' => '123456', 'email' => 'jane@myexample.com']\n];\n$smarty->assign('contacts',$data);\nThe template to output $contacts
{section name=customer loop=$contacts}\n<p>\n name: {$contacts[customer].name}<br />\n home: {$contacts[customer].home}<br />\n cell: {$contacts[customer].cell}<br />\n e-mail: {$contacts[customer].email}\n</p>\n{/section}\nThe above example will output:
<p>\n name: John Smith<br />\n home: 555-555-5555<br />\n cell: 666-555-5555<br />\n e-mail: john@myexample.com\n</p>\n<p>\n name: Jack Jones<br />\n home phone: 777-555-5555<br />\n cell phone: 888-555-5555<br />\n e-mail: jack@myexample.com\n</p>\n<p>\n name: Jane Munson<br />\n home phone: 000-555-5555<br />\n cell phone: 123456<br />\n e-mail: jane@myexample.com\n</p>\nThis example assumes that $custid, $name and $address are all arrays containing the same number of values. First the php script that assign's the arrays to Smarty.
<?php\n\n$id = [1001,1002,1003];\n$smarty->assign('custid',$id);\n\n$fullnames = ['John Smith','Jack Jones','Jane Munson'];\n$smarty->assign('name',$fullnames);\n\n$addr = ['253 Abbey road', '417 Mulberry ln', '5605 apple st'];\n$smarty->assign('address',$addr);\nThe loop variable only determines the number of times to loop. You can access ANY variable from the template within the {section}. This is useful for looping multiple arrays. You can pass an array which will determine the loop count by the array size, or you can pass an integer to specify the number of loops.
{section name=customer loop=$custid}\n<p>\n id: {$custid[customer]}<br />\n name: {$name[customer]}<br />\n address: {$address[customer]}\n</p>\n{/section}\nThe above example will output:
<p>\n id: 1000<br />\n name: John Smith<br />\n address: 253 Abbey road\n</p>\n<p>\n id: 1001<br />\n name: Jack Jones<br />\n address: 417 Mulberry ln\n</p>\n<p>\n id: 1002<br />\n name: Jane Munson<br />\n address: 5605 apple st\n</p>\n{section}'s can be nested as deep as you like. With nested {section}'s, you can access complex data structures, such as multidimensional arrays. This is an example .php script that assigns the arrays.
<?php\n\n$id = [1001,1002,1003];\n$smarty->assign('custid',$id);\n\n$fullnames = ['John Smith','Jack Jones','Jane Munson'];\n$smarty->assign('name',$fullnames);\n\n$addr = ['253 N 45th', '417 Mulberry ln', '5605 apple st'];\n$smarty->assign('address',$addr);\n\n$types = [\n [ 'home phone', 'cell phone', 'e-mail'],\n [ 'home phone', 'web'],\n [ 'cell phone']\n ];\n$smarty->assign('contact_type', $types);\n\n$info = [\n ['555-555-5555', '666-555-5555', 'john@myexample.com'],\n [ '123-456-4', 'www.example.com'],\n [ '0457878']\n ];\n$smarty->assign('contact_info', $info);\nIn this template, $contact_type[customer] is an array of contact types for the current customer.
{section name=customer loop=$custid}\n<hr>\n id: {$custid[customer]}<br />\n name: {$name[customer]}<br />\n address: {$address[customer]}<br />\n {section name=contact loop=$contact_type[customer]}\n {$contact_type[customer][contact]}: {$contact_info[customer][contact]}<br />\n {/section}\n{/section}\nThe above example will output:
<hr>\n id: 1000<br />\n name: John Smith<br />\n address: 253 N 45th<br />\n home phone: 555-555-5555<br />\n cell phone: 666-555-5555<br />\n e-mail: john@myexample.com<br />\n<hr>\n id: 1001<br />\n name: Jack Jones<br />\n address: 417 Mulberry ln<br />\n home phone: 123-456-4<br />\n web: www.example.com<br />\n<hr>\n id: 1002<br />\n name: Jane Munson<br />\n address: 5605 apple st<br />\n cell phone: 0457878<br />\nResults of a database search (eg ADODB or PEAR) are assigned to Smarty
<?php\n$sql = 'select id, name, home, cell, email from contacts '\n .\"where name like '$foo%' \";\n$smarty->assign('contacts', $db->getAll($sql));\nThe template to output the database result in a HTML table
<table>\n <tr><th> </th><th>Name</th><th>Home</th><th>Cell</th><th>Email</th></tr>\n {section name=co loop=$contacts}\n <tr>\n <td><a href=\"view.php?id={$contacts[co].id}\">view</a></td>\n <td>{$contacts[co].name}</td>\n <td>{$contacts[co].home}</td>\n <td>{$contacts[co].cell}</td>\n <td>{$contacts[co].email}</td>\n <tr>\n {sectionelse}\n <tr><td colspan=\"5\">No items found</td></tr>\n {/section}\n</table>\nindex contains the current array index, starting with zero or the start attribute if given. It increments by one or by the step attribute if given.
Note
If the step and start properties are not modified, then this works the same as the iteration property, except it starts at zero instead of one.
Note
$custid[customer.index] and $custid[customer] are identical.
{section name=customer loop=$custid}\n {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\nThe above example will output:
0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nindex_prev is the previous loop index. On the first loop, this is set to -1.
index_next is the next loop index. On the last loop, this is still one more than the current index, respecting the setting of the step attribute, if given.
<?php\n $data = [1001,1002,1003,1004,1005];\n $smarty->assign('rows',$data);\nTemplate to output the above array in a table
{* $rows[row.index] and $rows[row] are identical in meaning *}\n<table>\n <tr>\n <th>index</th><th>id</th>\n <th>index_prev</th><th>prev_id</th>\n <th>index_next</th><th>next_id</th>\n </tr>\n{section name=row loop=$rows}\n <tr>\n <td>{$smarty.section.row.index}</td><td>{$rows[row]}</td>\n <td>{$smarty.section.row.index_prev}</td><td>{$rows[row.index_prev]}</td>\n <td>{$smarty.section.row.index_next}</td><td>{$rows[row.index_next]}</td>\n </tr>\n{/section}\n</table>\nThe above example will output a table containing the following:
index id index_prev prev_id index_next next_id\n 0 1001 -1 1 1002\n 1 1002 0 1001 2 1003\n 2 1003 1 1002 3 1004\n 3 1004 2 1003 4 1005\n 4 1005 3 1004 5\niteration contains the current loop iteration and starts at one.
Note
This is not affected by the {section} properties start, step and max, unlike the index property. iteration also starts with one instead of zero unlike index. rownum is an alias to iteration, they are identical.
<?php\n// array of 3000 to 3015\n$id = range(3000,3015);\n$smarty->assign('arr', $id);\nTemplate to output every other element of the $arr array as step=2
{section name=cu loop=$arr start=5 step=2}\n iteration={$smarty.section.cu.iteration}\n index={$smarty.section.cu.index}\n id={$custid[cu]}<br />\n{/section}\nThe above example will output:
iteration=1 index=5 id=3005<br />\niteration=2 index=7 id=3007<br />\niteration=3 index=9 id=3009<br />\niteration=4 index=11 id=3011<br />\niteration=5 index=13 id=3013<br />\niteration=6 index=15 id=3015<br />\nAnother example that uses the iteration property to output a table header block every five rows.
<table>\n {section name=co loop=$contacts}\n {if $smarty.section.co.iteration is div by 5}\n <tr><th> </th><th>Name</th><th>Home</th><th>Cell</th><th>Email</th></tr>\n {/if}\n <tr>\n <td><a href=\"view.php?id={$contacts[co].id}\">view<a></td>\n <td>{$contacts[co].name}</td>\n <td>{$contacts[co].home}</td>\n <td>{$contacts[co].cell}</td>\n <td>{$contacts[co].email}</td>\n <tr>\n {/section}\n</table>\nAn example that uses the index property to alternate a text color every third row.
<table>\n {section name=co loop=$contacts}\n {if $smarty.section.co.index is even by 3}\n <span style=\"color: #ffffff\">{$contacts[co].name}</span>\n {else}\n <span style=\"color: #dddddd\">{$contacts[co].name}</span>\n {/if}\n {/section}\n</table>\nNote
The \"is div by\" syntax is a simpler alternative to the PHP mod operator syntax. The mod operator is allowed: {if $smarty.section.co.iteration % 5 == 1} will work just the same.
Note
You can also use \"is odd by\" to reverse the alternating.
"},{"location":"designers/language-builtin-functions/language-function-section/#first","title":".first","text":"first is set to TRUE if the current {section} iteration is the initial one.
last is set to TRUE if the current section iteration is the final one.
This example loops the $customers array, outputs a header block on the first iteration and on the last outputs the footer block. Also uses the total property.
{section name=customer loop=$customers}\n {if $smarty.section.customer.first}\n <table>\n <tr><th>id</th><th>customer</th></tr>\n {/if}\n\n <tr>\n <td>{$customers[customer].id}}</td>\n <td>{$customers[customer].name}</td>\n </tr>\n\n {if $smarty.section.customer.last}\n <tr><td></td><td>{$smarty.section.customer.total} customers</td></tr>\n </table>\n {/if}\n{/section}\nrownum contains the current loop iteration, starting with one. It is an alias to iteration, they work identically.
loop contains the last index number that this {section} looped. This can be used inside or after the {section}.
{section name=customer loop=$custid}\n {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\nThere are {$smarty.section.customer.loop} customers shown above.\nThe above example will output:
0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nThere are 3 customers shown above.\nshow is used as a parameter to section and is a boolean value. If FALSE, the section will not be displayed. If there is a {sectionelse} present, that will be alternately displayed.
Boolean $show_customer_info has been passed from the PHP application, to regulate whether this section shows.
{section name=customer loop=$customers show=$show_customer_info}\n {$smarty.section.customer.rownum} id: {$customers[customer]}<br />\n{/section}\n\n{if $smarty.section.customer.show}\n the section was shown.\n{else}\n the section was not shown.\n{/if}\nThe above example will output:
1 id: 1000<br />\n2 id: 1001<br />\n3 id: 1002<br />\n\nthe section was shown.\ntotal contains the number of iterations that this {section} will loop. This can be used inside or after a {section}.
{section name=customer loop=$custid step=2}\n {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\n There are {$smarty.section.customer.total} customers shown above.\nSee also {foreach}, {for}, {while} and $smarty.section.
The {setfilter}...{/setfilter} block tag allows the definition of template instance's variable filters.
SYNTAX: {setfilter filter1\\|filter2\\|filter3\\....}\\...{/setfilter}
The filter can be:
A variable filter plugin specified by it's name.
A modifier specified by it's name and optional additional parameter.
{setfilter}...{/setfilter} blocks can be nested. The filter definition of inner blocks does replace the definition of the outer block.
Template instance filters run in addition to other modifiers and filters. They run in the following order: modifier, default_modifier, $escape_html, registered variable filters, autoloaded variable filters, template instance's variable filters. Everything after default_modifier can be disabled with the nofilter flag.
Note
The setting of template instance filters does not affect the output of included subtemplates.
"},{"location":"designers/language-builtin-functions/language-function-setfilter/#examples","title":"Examples","text":"<script>\n {setfilter filter1}\n {$foo} {* filter1 runs on output of $foo *}\n {setfilter filter2|mod:true}\n {$bar} {* filter2 and modifier mod runs on output of $bar *}\n {/setfilter}\n {$buh} {* filter1 runs on output of $buh *}\n {/setfilter}\n {$blar} {* no template instance filter runs on output of $blar}\n</script>\nMany times web designers run into the issue where white space and carriage returns affect the output of the rendered HTML (browser \"features\"), so you must run all your tags together in the template to get the desired results. This usually ends up in unreadable or unmanageable templates.
Anything within {strip}{/strip} tags are stripped of the extra spaces or carriage returns at the beginnings and ends of the lines before they are displayed. This way you can keep your templates readable, and not worry about extra white space causing problems.
Note
{strip}{/strip} does not affect the contents of template variables, see the strip modifier instead.
{* the following will be all run into one line upon output *}\n{strip}\n <table>\n <tr>\n <td>\n <a href=\"#\">\n This is a test\n </a>\n </td>\n </tr>\n </table>\n{/strip}\nThe above example will output:
<table><tr><td><a href=\"#\">This is a test</a></td></tr></table>\nNotice that in the above example, all the lines begin and end with HTML tags. Be aware that all the lines are run together. If you have plain text at the beginning or end of any line, they will be run together, and may not be desired results.
See also the strip modifier.
{while} loops in Smarty have much the same flexibility as PHP while statements, with a few added features for the template engine. Every {while} must be paired with a matching {/while}. All operators are recognized, such as ==, ||, or, &&, and, etc and you can use modifiers as functions, such as is_array().
{while $foo > 0}\n {$foo--}\n{/while}\nThe above example will count down the value of $foo until 1 is reached.
See also {foreach}, {for} and {section}.
Smarty comes with several custom plugin functions that you can use in the templates.
{counter} is used to print out a count. {counter} will remember the count on each iteration. You can adjust the number, the interval and the direction of the count, as well as determine whether to print the value. You can run multiple counters concurrently by supplying a unique name for each one. If you do not supply a name, the name \"default\" will be used.
If you supply the assign attribute, the output of the {counter} function will be assigned to this template variable instead of being output to the template.
{* initialize the count *}\n{counter start=0 skip=2}<br />\n{counter}<br />\n{counter}<br />\n{counter}<br />\nthis will output:
0<br />\n2<br />\n4<br />\n6<br />\n{cycle} is used to alternate a set of values. This makes it easy to for example, alternate between two or more colors in a table, or cycle through an array of values.
You can {cycle} through more than one set of values in a template by supplying a name attribute. Give each {cycle} a unique name.
You can force the current value not to print with the print attribute set to FALSE. This would be useful for silently skipping a value.
The advance attribute is used to repeat a value. When set to FALSE, the next call to {cycle} will print the same value.
If you supply the assign attribute, the output of the {cycle} function will be assigned to a template variable instead of being output to the template.
{section name=rows loop=$data}\n <tr class=\"{cycle values=\"odd,even\"}\">\n <td>{$data[rows]}</td>\n </tr>\n{/section}\nThe above template would output:
<tr class=\"odd\">\n <td>1</td>\n </tr>\n <tr class=\"even\">\n <td>2</td>\n </tr>\n <tr class=\"odd\">\n <td>3</td>\n </tr>\n{debug} dumps the debug console to the page. This works regardless of the debug settings in the php script. Since this gets executed at runtime, this is only able to show the assigned variables; not the templates that are in use. However, you can see all the currently available variables within the scope of a template.
See also the debugging console page.
"},{"location":"designers/language-custom-functions/language-function-eval/","title":"{eval}","text":"{eval} is used to evaluate a variable as a template. This can be used for things like embedding template tags/variables into variables or tags/variables into config file variables.
If you supply the assign attribute, the output of the {eval} function will be assigned to this template variable instead of being output to the template.
Note
Evaluated variables are treated the same as templates. They follow the same escapement and security features just as if they were templates.
Evaluated variables are compiled on every invocation, the compiled versions are not saved! However, if you have caching enabled, the output will be cached with the rest of the template.
If the content to evaluate doesn't change often, or is used repeatedly, consider using {include file=\"string:{$template_code}\"} instead. This may cache the compiled state and thus doesn't have to run the (comparably slow) compiler on every invocation.
The contents of the config file, setup.conf.
emphstart = <strong>\nemphend = </strong>\ntitle = Welcome to {$company}'s home page!\nErrorCity = You must supply a {#emphstart#}city{#emphend#}.\nErrorState = You must supply a {#emphstart#}state{#emphend#}.\nWhere the template is:
{config_load file='setup.conf'}\n\n{eval var=$foo}\n{eval var=#title#}\n{eval var=#ErrorCity#}\n{eval var=#ErrorState# assign='state_error'}\n{$state_error}\nThe above template will output:
This is the contents of foo.\nWelcome to Foobar Pub & Grill's home page!\nYou must supply a <strong>city</strong>.\nYou must supply a <strong>state</strong>.\nThis outputs the server name (in uppercase) and IP. The assigned variable $str could be from a database query.
<?php\n $str = 'The server name is {$smarty.server.SERVER_NAME|upper} '\n .'at {$smarty.server.SERVER_ADDR}';\n $smarty->assign('foo',$str);\nWhere the template is:
{eval var=$foo}\n{fetch} is used to retrieve files from the local file system, http, or ftp and display the contents.
If the file name begins with http://, the website page will be fetched and displayed.
Note
This will not support http redirects, be sure to include a trailing slash on your web page fetches where necessary.
If the file name begins with ftp://, the file will be downloaded from the ftp server and displayed.
For local files, either a full system file path must be given, or a path relative to the executed php script.
Note
If security is enabled, and you are fetching a file from the local file system, {fetch} will only allow files from within the $secure_dir path of the security policy. See the Security section for details.
If the assign attribute is set, the output of the {fetch} function will be assigned to this template variable instead of being output to the template.
{* include some javascript in your template *}\n{fetch file='/export/httpd/www.example.com/docs/navbar.js'}\n\n{* embed some weather text in your template from another web site *}\n{fetch file='http://www.myweather.com/68502/'}\n\n{* fetch a news headline file via ftp *}\n{fetch file='ftp://user:password@ftp.example.com/path/to/currentheadlines.txt'}\n{* as above but with variables *}\n{fetch file=\"ftp://`$user`:`$password`@`$server`/`$path`\"}\n\n{* assign the fetched contents to a template variable *}\n{fetch file='http://www.myweather.com/68502/' assign='weather'}\n{if $weather ne ''}\n <div id=\"weather\">{$weather}</div>\n{/if}\nSee also {capture}, {eval}, {assign} and fetch().
{html_checkboxes} is a custom function that creates an html checkbox group with provided data. It takes care of which item(s) are selected by default as well.
Required attributes are values and output, unless you use options instead.
All output is XHTML compliant.
All parameters that are not in the list above are printed as name/value-pairs inside each of the created <input>-tags.
<?php\n\n$smarty->assign('cust_ids', array(1000,1001,1002,1003));\n$smarty->assign('cust_names', array(\n 'Joe Schmoe',\n 'Jack Smith',\n 'Jane Johnson',\n 'Charlie Brown')\n );\n$smarty->assign('customer_id', 1001);\nwhere template is
{html_checkboxes name='id' values=$cust_ids output=$cust_names selected=$customer_id separator='<br />'}\nor where PHP code is:
<?php\n\n$smarty->assign(\n 'cust_checkboxes', \n [\n 1000 => 'Joe Schmoe',\n 1001 => 'Jack Smith',\n 1002 => 'Jane Johnson',\n 1003 => 'Charlie Brown',\n ]\n);\n$smarty->assign('customer_id', 1001);\nand the template is
{html_checkboxes name='id' options=$cust_checkboxes selected=$customer_id separator='<br />'}\nboth examples will output:
<label><input type=\"checkbox\" name=\"id[]\" value=\"1000\" />Joe Schmoe</label><br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1001\" checked=\"checked\" />Jack Smith</label>\n<br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1002\" />Jane Johnson</label><br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1003\" />Charlie Brown</label><br />\n<?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, contact_type_id, contact '\n .'from contacts where contact_id=12';\n$smarty->assign('contact',$db->getRow($sql));\nThe results of the database queries above would be output with.
{html_checkboxes name='contact_type_id' options=$contact_types selected=$contact.contact_type_id separator='<br />'}\nSee also {html_radios} and {html_options}
{html_image} is a custom function that generates an HTML <img> tag. The height and width are automatically calculated from the image file if they are not supplied.
basedir is the base directory that relative image paths are based from. If not given, the web server's document root $_ENV['DOCUMENT_ROOT'] is used as the base. If security is enabled, then the image must be located in the $secure_dir path of the security policy. See the Security section for details.
href is the href value to link the image to. If link is supplied, an <a href=\"LINKVALUE\"><a> tag is placed around the image tag.
path_prefix is an optional prefix string you can give the output path. This is useful if you want to supply a different server name for the image.
All parameters that are not in the list above are printed as name/value-pairs inside the created <img> tag.
Note
{html_image} requires a hit to the disk to read the image and calculate the height and width. If you don't use template caching, it is generally better to avoid {html_image} and leave image tags static for optimal performance.
{html_image file='pumpkin.jpg'}\n{html_image file='/path/from/docroot/pumpkin.jpg'}\n{html_image file='../path/relative/to/currdir/pumpkin.jpg'}\nExample output of the above template would be:
<img src=\"pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n<img src=\"/path/from/docroot/pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n<img src=\"../path/relative/to/currdir/pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n{html_options} is a custom function that creates the html <select><option> group with the assigned data. It takes care of which item(s) are selected by default as well.
Required attributes are values and output, unless you use the combined options instead.
If the optional name attribute is given, the <select></select> tags are created, otherwise ONLY the <option> list is generated.
If a given value is an array, it will treat it as an html <optgroup>, and display the groups. Recursion is supported with <optgroup>.
All parameters that are not in the list above are printed as name/value-pairs inside the <select> tag. They are ignored if the optional name is not given.
All output is XHTML compliant.
<?php\n$smarty->assign('myOptions', [\n 1800 => 'Joe Schmoe',\n 9904 => 'Jack Smith',\n 2003 => 'Charlie Brown']\n );\n$smarty->assign('mySelect', 9904);\nThe following template will generate a drop-down list. Note the presence of the name attribute which creates the <select> tags.
{html_options name=foo options=$myOptions selected=$mySelect}\nOutput of the above example would be:
<select name=\"foo\">\n <option value=\"1800\">Joe Schmoe</option>\n <option value=\"9904\" selected=\"selected\">Jack Smith</option>\n <option value=\"2003\">Charlie Brown</option>\n</select> \n<?php\n$smarty->assign('cust_ids', [56,92,13]);\n$smarty->assign('cust_names', [\n 'Joe Schmoe',\n 'Jane Johnson',\n 'Charlie Brown']);\n$smarty->assign('customer_id', 92);\nThe above arrays would be output with the following template (note the use of the php count() function as a modifier to set the select size).
<select name=\"customer_id\" size=\"{$cust_names|@count}\">\n {html_options values=$cust_ids output=$cust_names selected=$customer_id}\n</select>\nThe above example would output:
<select name=\"customer_id\" size=\"3\">\n <option value=\"56\">Joe Schmoe</option>\n <option value=\"92\" selected=\"selected\">Jane Johnson</option>\n <option value=\"13\">Charlie Brown</option>\n</select>\n<?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, name, email, contact_type_id\n from contacts where contact_id='.$contact_id;\n$smarty->assign('contact',$db->getRow($sql));\nWhere a template could be as follows. Note the use of the truncate modifier.
<select name=\"type_id\">\n <option value='null'>-- none --</option>\n {html_options options=$contact_types|truncate:20 selected=$contact.type_id}\n</select>\n<?php\n$arr['Sport'] = array(6 => 'Golf', 9 => 'Cricket',7 => 'Swim');\n$arr['Rest'] = array(3 => 'Sauna',1 => 'Massage');\n$smarty->assign('lookups', $arr);\n$smarty->assign('fav', 7);\nThe script above and the following template
{html_options name=foo options=$lookups selected=$fav}\nwould output:
<select name=\"foo\">\n <optgroup label=\"Sport\">\n <option value=\"6\">Golf</option>\n <option value=\"9\">Cricket</option>\n <option value=\"7\" selected=\"selected\">Swim</option>\n </optgroup>\n <optgroup label=\"Rest\">\n <option value=\"3\">Sauna</option>\n <option value=\"1\">Massage</option>\n </optgroup>\n</select>\nSee also {html_checkboxes} and {html_radios}
{html_radios} is a custom function that creates an HTML radio button group. It also takes care of which item is selected by default as well.
Required attributes are values and output, unless you use options instead.
All output is XHTML compliant.
All parameters that are not in the list above are output as name/value-pairs inside each of the created <input>-tags.
<?php\n\n$smarty->assign('cust_ids', array(1000,1001,1002,1003));\n$smarty->assign('cust_names', array(\n 'Joe Schmoe',\n 'Jack Smith',\n 'Jane Johnson',\n 'Charlie Brown')\n );\n$smarty->assign('customer_id', 1001);\nWhere template is:
{html_radios name='id' values=$cust_ids output=$cust_names\n selected=$customer_id separator='<br />'}\n<?php\n$smarty->assign('cust_radios', array(\n 1000 => 'Joe Schmoe',\n 1001 => 'Jack Smith',\n 1002 => 'Jane Johnson',\n 1003 => 'Charlie Brown'));\n$smarty->assign('customer_id', 1001);\nWhere template is:
{html_radios name='id' options=$cust_radios\n selected=$customer_id separator='<br />'}\nBoth examples will output:
<label><input type=\"radio\" name=\"id\" value=\"1000\" />Joe Schmoe</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1001\" checked=\"checked\" />Jack Smith</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1002\" />Jane Johnson</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1003\" />Charlie Brown</label><br />\n<?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, name, email, contact_type_id '\n .'from contacts where contact_id='.$contact_id;\n$smarty->assign('contact',$db->getRow($sql));\nThe variable assigned from the database above would be output with the template:
{html_radios name='contact_type_id' options=$contact_types\n selected=$contact.contact_type_id separator='<br />'}\nSee also {html_checkboxes} and {html_options}
{html_select_date} is a custom function that creates date dropdowns. It can display any or all of: year, month, and day. All parameters that are not in the list below are printed as name/value-pairs inside the <select> tags of day, month and year.
Note
There is an useful php function on the date tips page for converting {html_select_date} form values to a timestamp.
Template code
{html_select_date}\nThis will output:
<select name=\"Date_Month\">\n <option value=\"1\">January</option>\n <option value=\"2\">February</option>\n <option value=\"3\">March</option>\n ..... snipped .....\n <option value=\"10\">October</option>\n <option value=\"11\">November</option>\n <option value=\"12\" selected=\"selected\">December</option>\n</select>\n<select name=\"Date_Day\">\n <option value=\"1\">01</option>\n <option value=\"2\">02</option>\n <option value=\"3\">03</option>\n ..... snipped .....\n <option value=\"11\">11</option>\n <option value=\"12\">12</option>\n <option value=\"13\" selected=\"selected\">13</option>\n <option value=\"14\">14</option>\n <option value=\"15\">15</option>\n ..... snipped .....\n <option value=\"29\">29</option>\n <option value=\"30\">30</option>\n <option value=\"31\">31</option>\n</select>\n<select name=\"Date_Year\">\n <option value=\"2006\" selected=\"selected\">2006</option>\n</select>\n{* start and end year can be relative to current year *}\n{html_select_date prefix='StartDate' time=$time start_year='-5'\n end_year='+1' display_days=false}\nWith 2000 as the current year the output:
<select name=\"StartDateMonth\">\n <option value=\"1\">January</option>\n <option value=\"2\">February</option>\n .... snipped ....\n <option value=\"11\">November</option>\n <option value=\"12\" selected=\"selected\">December</option>\n</select>\n<select name=\"StartDateYear\">\n <option value=\"1995\">1995</option>\n .... snipped ....\n <option value=\"1999\">1999</option>\n <option value=\"2000\" selected=\"selected\">2000</option>\n <option value=\"2001\">2001</option>\n</select>\nSee also {html_select_time}, date_format, $smarty.now and the date tips page.
{html_select_time} is a custom function that creates time dropdowns for you. It can display any or all of: hour, minute, second and meridian.
The time attribute can have different formats. It can be a unique timestamp, a string of the format YYYYMMDDHHMMSS or a string that is parseable by PHP's strtotime().
strtotime(). If an array is given, the attributes field_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from. display_hours TRUE Whether or not to display hours display_minutes TRUE Whether or not to display minutes display_seconds TRUE Whether or not to display seconds display_meridian TRUE Whether or not to display meridian (am/pm) use_24_hours TRUE Whether or not to use 24 hour clock minute_interval 1 Number interval in minute dropdown second_interval 1 Number interval in second dropdown hour_format \\%02d What format the hour label should be in (sprintf) hour_value_format \\%20d What format the hour value should be in (sprintf) minute_format \\%02d What format the minute label should be in (sprintf) minute_value_format \\%20d What format the minute value should be in (sprintf) second_format \\%02d What format the second label should be in (sprintf) second_value_format \\%20d What format the second value should be in (sprintf) field_array n/a Outputs values to array of this name all_extra null Adds extra attributes to select/input tags if given hour_extra null Adds extra attributes to select/input tags if given minute_extra null Adds extra attributes to select/input tags if given second_extra null Adds extra attributes to select/input tags if given meridian_extra null Adds extra attributes to select/input tags if given field_separator \\n String printed between different fields option_separator \\n String printed between different options of a field all_id null Adds id-attribute to all select/input tags if given hour_id null Adds id-attribute to select/input tags if given minute_id null Adds id-attribute to select/input tags if given second_id null Adds id-attribute to select/input tags if given meridian_id null Adds id-attribute to select/input tags if given all_empty null If supplied then the first element of any select-box has this value as it's label and \"\" as it's value. This is useful to make the select-boxes read \"Please select\" for example. hour_empty null If supplied then the first element of the hour's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an hour\" for example. minute_empty null If supplied then the first element of the minute's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an minute\" for example. second_empty null If supplied then the first element of the second's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an second\" for example. meridian_empty null If supplied then the first element of the meridian's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an meridian\" for example."},{"location":"designers/language-custom-functions/language-function-html-select-time/#examples","title":"Examples","text":"{html_select_time use_24_hours=true}\nAt 9:20 and 23 seconds in the morning the template above would output:
<select name=\"Time_Hour\">\n <option value=\"00\">00</option>\n <option value=\"01\">01</option>\n ... snipped ....\n <option value=\"08\">08</option>\n <option value=\"09\" selected>09</option>\n <option value=\"10\">10</option>\n ... snipped ....\n <option value=\"22\">22</option>\n <option value=\"23\">23</option>\n</select>\n<select name=\"Time_Minute\">\n <option value=\"00\">00</option>\n <option value=\"01\">01</option>\n ... snipped ....\n <option value=\"19\">19</option>\n <option value=\"20\" selected>20</option>\n <option value=\"21\">21</option>\n ... snipped ....\n <option value=\"58\">58</option>\n <option value=\"59\">59</option>\n</select>\n<select name=\"Time_Second\">\n <option value=\"00\">00</option>\n <option value=\"01\">01</option>\n ... snipped ....\n <option value=\"22\">22</option>\n <option value=\"23\" selected>23</option>\n <option value=\"24\">24</option>\n ... snipped ....\n <option value=\"58\">58</option>\n <option value=\"59\">59</option>\n</select>\n<select name=\"Time_Meridian\">\n <option value=\"am\" selected>AM</option>\n <option value=\"pm\">PM</option>\n</select>\nSee also $smarty.now, {html_select_date} and the date tips page.
{html_table} is a custom function that dumps an array of data into an HTML <table>.
<caption> element of the table table_attr No Attributes for <table> tag (defaults to 'border=\"1\"') th_attr No Attributes for <th> tag (arrays are cycled) tr_attr No attributes for <tr> tag (arrays are cycled) td_attr No Attributes for <td> tag (arrays are cycled) trailpad No Value to pad the trailing cells on last row with (if any) (defaults to '\u00a0') hdir No Direction of each row to be rendered. possible values: right (left-to-right), and left (right-to-left) (defaults to 'right') vdir No Direction of each column to be rendered. possible values: down (top-to-bottom), up (bottom-to-top) (defaults to 'down') The cols attribute determines how many columns will be in the table.
The table_attr, tr_attr and td_attr values determine the attributes given to the <table>, <tr> and <td> tags.
If tr_attr or td_attr are arrays, they will be cycled through.
trailpad is the value put into the trailing cells on the last table row if there are any present.
<?php\n$smarty->assign( 'data', array(1,2,3,4,5,6,7,8,9) );\n$smarty->assign( 'tr', array('bgcolor=\"#eeeeee\"','bgcolor=\"#dddddd\"') );\n$smarty->display('index.tpl');\nThe variables assigned from php could be displayed as these three examples demonstrate. Each example shows the template followed by output.
** Example 1 **
{html_table loop=$data}\n<table border=\"1\">\n <tbody>\n <tr><td>1</td><td>2</td><td>3</td></tr>\n <tr><td>4</td><td>5</td><td>6</td></tr>\n <tr><td>7</td><td>8</td><td>9</td></tr>\n </tbody>\n</table>\n** Example 2 **
{html_table loop=$data cols=4 table_attr='border=\"0\"'}\n<table border=\"0\">\n <tbody>\n <tr><td>1</td><td>2</td><td>3</td><td>4</td></tr>\n <tr><td>5</td><td>6</td><td>7</td><td>8</td></tr>\n <tr><td>9</td><td> </td><td> </td><td> </td></tr>\n </tbody>\n</table>\n** Example 3 **
{html_table loop=$data cols=\"first,second,third,fourth\" tr_attr=$tr}\n<table border=\"1\">\n <thead>\n <tr>\n <th>first</th><th>second</th><th>third</th><th>fourth</th>\n </tr>\n </thead>\n <tbody>\n <tr bgcolor=\"#eeeeee\"><td>1</td><td>2</td><td>3</td><td>4</td></tr>\n <tr bgcolor=\"#dddddd\"><td>5</td><td>6</td><td>7</td><td>8</td></tr>\n <tr bgcolor=\"#eeeeee\"><td>9</td><td> </td><td> </td><td> </td></tr>\n </tbody>\n</table>\n{mailto} automates the creation of a mailto: anchor links and optionally encodes them. Encoding emails makes it more difficult for web spiders to lift email addresses off of a site.
none, hex, javascript or javascript_charcode. cc No Email addresses to carbon copy, separate entries by a comma. bcc No Email addresses to blind carbon copy, separate entries by a comma subject No Email subject newsgroups No Newsgroups to post to, separate entries by a comma. followupto No Addresses to follow up to, separate entries by a comma. extra No Any extra information you want passed to the link, such as style sheet classes Note
Javascript is probably the most thorough form of encoding, although you can use hex encoding too.
"},{"location":"designers/language-custom-functions/language-function-mailto/#examples","title":"Examples","text":"{mailto address=\"me@example.com\"}\n<a href=\"mailto:me@example.com\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" text=\"send me some mail\"}\n<a href=\"mailto:me@example.com\" >send me some mail</a>\n\n{mailto address=\"me@example.com\" encode=\"javascript\"}\n <script>\n eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b'))\n</script>\n\n{mailto address=\"me@example.com\" encode=\"hex\"}\n<a href=\"mailto:%6d%65.. snipped..3%6f%6d\">m&..snipped...#x6f;m</a>\n\n{mailto address=\"me@example.com\" subject=\"Hello to you!\"}\n<a href=\"mailto:me@example.com?subject=Hello%20to%20you%21\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" cc=\"you@example.com,they@example.com\"}\n<a href=\"mailto:me@example.com?cc=you@example.com,they@example.com\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" extra='class=\"email\"'}\n<a href=\"mailto:me@example.com\" class=\"email\">me@example.com</a>\n\n{mailto address=\"me@example.com\" encode=\"javascript_charcode\"}\n <script>\n {document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))}\n</script>\nSee also escape, {textformat} and obfuscating email addresses.
{math} allows the template designer to do math equations in the template.
Any numeric template variables may be used in the equations, and the result is printed in place of the tag.
The variables used in the equation are passed as parameters, which can be template variables or static values.
+, -, /, *, abs, ceil, cos, exp, floor, log, log10, max, min, pi, pow, rand, round, sin, sqrt, srans and tan are all valid operators. Check the PHP documentation for further information on these math functions.
If you supply the assign attribute, the output of the {math} function will be assigned to this template variable instead of being output to the template.
Note
{math} is an expensive function in performance due to its use of the php eval() function. Doing the math in PHP is much more efficient, so whenever possible do the math calculations in the script and assign() the results to the template. Definitely avoid repetitive {math} function calls, eg within {section} loops.
Example 1
{* $height=4, $width=5 *}\n\n{math equation=\"x + y\" x=$height y=$width}\nThe above example will output:
9\nExample 2
{* $row_height = 10, $row_width = 20, #col_div# = 2, assigned in template *}\n\n{math equation=\"height * width / division\"\n height=$row_height\n width=$row_width\n division=#col_div#}\nThe above example will output:
100\nExample 3
{* you can use parenthesis *}\n\n{math equation=\"(( x + y ) / z )\" x=2 y=10 z=2}\nThe above example will output:
6\nExample 4
{* you can supply a format parameter in sprintf format *}\n\n{math equation=\"x + y\" x=4.4444 y=5.0000 format=\"%.2f\"}\nThe above example will output:
9.44\n{textformat} is a block tag used to format text. It basically cleans up spaces and special characters, and formats paragraphs by wrapping at a boundary and indenting lines.
You can set the parameters explicitly, or use a preset style. Currently, \"email\" is the only available style.
"},{"location":"designers/language-custom-functions/language-function-textformat/#attributes","title":"Attributes","text":"Attribute Name Default Description style n/a Preset style indent 0 The number of chars to indent every line indent_first 0 The number of chars to indent the first line indent_char (single space) The character (or string of chars) to indent with wrap 80 How many characters to wrap each line to wrap_char \\n The character (or string of chars) to break each line with wrap_cut FALSE If TRUE, wrap will break the line at the exact character instead of at a word boundary assign n/a The template variable the output will be assigned to"},{"location":"designers/language-custom-functions/language-function-textformat/#examples","title":"Examples","text":"{textformat wrap=40}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\n\n{/textformat}\nThe above example will output:
This is foo. This is foo. This is foo.\nThis is foo. This is foo. This is foo.\n\nThis is bar.\n\nbar foo bar foo foo. bar foo bar foo\nfoo. bar foo bar foo foo. bar foo bar\nfoo foo. bar foo bar foo foo. bar foo\nbar foo foo. bar foo bar foo foo.\n{textformat wrap=40 indent=4}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\n\n{/textformat}\nThe above example will output:
This is foo. This is foo. This is\n foo. This is foo. This is foo. This\n is foo.\n\n This is bar.\n\n bar foo bar foo foo. bar foo bar foo\n foo. bar foo bar foo foo. bar foo\n bar foo foo. bar foo bar foo foo.\n bar foo bar foo foo. bar foo bar\n foo foo.\n{textformat wrap=40 indent=4 indent_first=4}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\n\n{/textformat}\nThe above example will output:
This is foo. This is foo. This\n is foo. This is foo. This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo. bar foo bar\n foo foo. bar foo bar foo foo. bar\n foo bar foo foo. bar foo bar foo\n foo. bar foo bar foo foo. bar foo\n bar foo foo.\n{textformat style=\"email\"}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\n\n{/textformat}\nThe above example will output:
This is foo. This is foo. This is foo. This is foo. This is foo. This is\nfoo.\n\nThis is bar.\n\nbar foo bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo\nbar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo\nfoo.\nSee also {strip} and wordwrap.
Variable modifiers can be applied to variables, custom tags or strings. To apply a modifier, specify the value followed by a | (pipe) and the modifier name. A modifier may accept additional parameters that affect its behavior. These parameters follow the modifier name and are separated by a : (colon).
Modifiers can be applied to any type of variables, including arrays and objects.
"},{"location":"designers/language-modifiers/#examples","title":"Examples","text":"{* apply modifier to a variable *}\n{$title|upper}\n\n{* modifier with parameters *}\n{$title|truncate:40:\"...\"}\n\n{* apply modifier to a function parameter *}\n{html_table loop=$myvar|upper}\n\n{* with parameters *}\n{html_table loop=$myvar|truncate:40:\"...\"}\n\n{* apply modifier to literal string *}\n{\"foobar\"|upper}\n\n{* using date_format to format the current date *}\n{$smarty.now|date_format:\"%Y/%m/%d\"}\n\n{* apply modifier to a custom function *}\n{mailto|upper address=\"smarty@example.com\"}\n\n{* using php's str_repeat *}\n{\"=\"|str_repeat:80}\n\n{* php's count *}\n{$myArray|@count}\n\n{* this will uppercase the whole array *}\n<select name=\"name_id\">\n{html_options output=$my_array|upper}\n</select>\nYou can apply any number of modifiers to a variable. They will be applied in the order they are combined, from left to right. They must be separated with a | (pipe) character.
<?php\n\n$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');\nwhere template is:
{$articleTitle}\n{$articleTitle|upper|spacify}\n{$articleTitle|lower|spacify|truncate}\n{$articleTitle|lower|truncate:30|spacify}\n{$articleTitle|lower|spacify|truncate:30:\". . .\"}\nThe above example will output:
Smokers are Productive, but Death Cuts Efficiency.\nS M O K E R S A R ....snip.... H C U T S E F F I C I E N C Y .\ns m o k e r s a r ....snip.... b u t d e a t h c u t s...\ns m o k e r s a r e p r o d u c t i v e , b u t . . .\ns m o k e r s a r e p. . .\nModifiers can also be used in expressions. For example, you can use the isset modifier to test if a variable holds a value different from null.
{if $varA|isset}\n <b>variable A is set</b>\n{/if}\nYou can also use modifiers in expressions in a PHP-style syntax:
{if isset($varA)}\n <b>variable A is set</b>\n{/if}\nSee also registerPlugin(), combining modifiers. and extending smarty with plugins
This is used to capitalize the first letter of all words in a variable. This is similar to the PHP ucwords() function.
{$myVar|capitalize}\n<?php\n\n $smarty->assign('articleTitle', 'next x-men film, x3, delayed.');\nWhere the template is:
{$articleTitle}\n {$articleTitle|capitalize}\n {$articleTitle|capitalize:true}\nWill output:
next x-men film, x3, delayed.\n Next X-Men Film, x3, Delayed.\n Next X-Men Film, X3, Delayed.\nSee also lower and upper
This value is concatenated to the given variable.
"},{"location":"designers/language-modifiers/language-modifier-cat/#basic-usage","title":"Basic usage","text":"{$myVar|cat:' units'}\n<?php\n\n $smarty->assign('articleTitle', \"Psychics predict world didn't end\");\nWhere template is:
{$articleTitle|cat:' yesterday.'}\nWill output:
Psychics predict world didn't end yesterday.\nThis is used to count the number of characters in a variable.
"},{"location":"designers/language-modifiers/language-modifier-count-characters/#basic-usage","title":"Basic usage","text":"{$myVar|count_characters}\n<?php\n\n $smarty->assign('articleTitle', 'Cold Wave Linked to Temperatures.');\nWhere template is:
{$articleTitle}\n {$articleTitle|count_characters}\n {$articleTitle|count_characters:true}\nWill output:
Cold Wave Linked to Temperatures.\n 29\n 33\nSee also count_words, count_sentences and count_paragraphs.
This is used to count the number of paragraphs in a variable.
"},{"location":"designers/language-modifiers/language-modifier-count-paragraphs/#basic-usage","title":"Basic usage","text":"{$myVar|count_paragraphs}\n<?php\n\n $smarty->assign('articleTitle',\n \"War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\\n\\n\n Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\"\n );\nWhere template is:
{$articleTitle}\n {$articleTitle|count_paragraphs}\nWill output:
War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\n\n Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\n 2\nSee also count_characters, count_sentences and count_words.
This is used to count the number of sentences in a variable. A sentence being delimited by a dot, question- or exclamation-mark (.?!).
"},{"location":"designers/language-modifiers/language-modifier-count-sentences/#basic-usage","title":"Basic usage","text":"{$myVar|count_sentences}\n<?php\n\n $smarty->assign('articleTitle',\n 'Two Soviet Ships Collide - One Dies.\n Enraged Cow Injures Farmer with Axe.'\n );\nWhere template is:
{$articleTitle}\n {$articleTitle|count_sentences}\nWill output:
Two Soviet Ships Collide - One Dies. Enraged Cow Injures Farmer with Axe.\n 2\nSee also count_characters, count_paragraphs and count_words.
This is used to count the number of words in a variable.
"},{"location":"designers/language-modifiers/language-modifier-count-words/#basic-usage","title":"Basic usage","text":"{$myVar|count_words}\n<?php\n\n $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\nWhere template is:
{$articleTitle}\n {$articleTitle|count_words}\nThis will output:
Dealers Will Hear Car Talk at Noon.\n 7\nSee also count_characters, count_paragraphs and count_sentences.
Returns the number of elements in an array (or Countable object). Will return 0 for null. Returns 1 for any other type (such as a string).
If the optional mode parameter is set to 1, count() will recursively count the array. This is particularly useful for counting all the elements of a multidimensional array.
"},{"location":"designers/language-modifiers/language-modifier-count/#basic-usage","title":"Basic usage","text":"{if $myVar|count > 3}4 or more{/if}\n{if count($myVar) > 3}4 or more{/if}\nThis formats a date and time into the given strftime() format. Dates can be passed to Smarty as unix timestamps, DateTime objects, mysql timestamps or any string made up of month day year, parsable by php\\'s strtotime(). Designers can then use date_format to have complete control of the formatting of the date. If the date passed to date_format is empty and a second parameter is passed, that will be used as the date to format.
{$myVar|date_format:\"%Y-%m-%d\"}\nNote
Since Smarty-2.6.10 numeric values passed to date_format are always (except for mysql timestamps, see below) interpreted as a unix timestamp.
Before Smarty-2.6.10 numeric strings that where also parsable by strtotime() in php (like YYYYMMDD) where sometimes (depending on the underlying implementation of strtotime()) interpreted as date strings and NOT as timestamps.
The only exception are mysql timestamps: They are also numeric only and 14 characters long (YYYYMMDDHHMMSS), mysql timestamps have precedence over unix timestamps.
Note
date_format is essentially a wrapper to PHP's strftime() function. You may have more or less conversion specifiers available depending on your system's strftime() function where PHP was compiled. Check your system\\'s manpage for a full list of valid specifiers. However, a few of the specifiers are emulated on Windows. These are: %D, %e, %h, %l, %n, %r, %R, %t, %T.
<?php\n\n$config['date'] = '%I:%M %p';\n$config['time'] = '%H:%M:%S';\n$smarty->assign('config', $config);\n$smarty->assign('yesterday', strtotime('-1 day'));\nThis template uses $smarty.now to get the current time:
{$smarty.now|date_format}\n{$smarty.now|date_format:\"%D\"}\n{$smarty.now|date_format:$config.date}\n{$yesterday|date_format}\n{$yesterday|date_format:\"%A, %B %e, %Y\"}\n{$yesterday|date_format:$config.time}\nThis above will output:
Jan 1, 2022\n01/01/22\n02:33 pm\nDec 31, 2021\nMonday, December 1, 2021\n14:33:00\ndate_format conversion specifiers:
See also $smarty.now, strftime(), {html_select_date} and the date tips page.
Returns the value of the given variable in a human-readable format in HTML. Used in the debug console, but you can also use it in your template while developing to see what is going on under the hood.
Note
Use for debugging only! Since you may accidentally reveal sensitive information or introduce vulnerabilities such as XSS using this method never use it in production.
"},{"location":"designers/language-modifiers/language-modifier-debug-print-var/#basic-usage","title":"Basic usage","text":"{$myVar|debug_print_var}\nThis is used to set a default value for a variable. If the variable is unset or an empty string, the given default value is printed instead. Default takes the one argument.
"},{"location":"designers/language-modifiers/language-modifier-default/#basic-usage","title":"Basic usage","text":"{$myVar|default:\"(none)\"}\n<?php\n\n $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n $smarty->assign('email', '');\nWhere template is:
{$articleTitle|default:'no title'}\n{$myTitle|default:'no title'}\n{$email|default:'No email address available'}\nWill output:
Dealers Will Hear Car Talk at Noon.\nno title\nNo email address available\nSee also the default variable handling and the blank variable handling pages.
"},{"location":"designers/language-modifiers/language-modifier-empty/","title":"empty","text":"Returns true if var does not exist or has a value that is empty or equal to zero, aka falsey, see conversion to boolean. Otherwise returns false.
"},{"location":"designers/language-modifiers/language-modifier-empty/#basic-usage","title":"Basic usage","text":"{if $myVar|empty}it's an empty variable{/if}\n{if empty($myVar)}it's an empty variable{/if}\nescape is used to encode or escape a variable to html, url, single quotes, hex, hexentity, javascript and mail. By default its html.
{$myVar|escape}\nhtml, htmlall, url, urlpathinfo, quotes, hex, hexentity, javascript, mail html This is the escape format to use. 2 string No ISO-8859-1, UTF-8, and any character set supported by htmlentities() UTF-8 The character set encoding passed to htmlentities() et. al. 3 boolean No FALSE TRUE Double encode entities from & to & (applies to html and htmlall only)"},{"location":"designers/language-modifiers/language-modifier-escape/#examples","title":"Examples","text":"<?php\n\n$smarty->assign('articleTitle',\n \"'Stiff Opposition Expected to Casketless Funeral Plan'\"\n );\n$smarty->assign('EmailAddress','smarty@example.com');\nThese are example escape template lines followed by the output
{$articleTitle}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape:'html'} {* escapes & \" ' < > *}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape:'htmlall'} {* escapes ALL html entities *}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n<a href=\"?title={$articleTitle|escape:'url'}\">click here</a>\n<a\nhref=\"?title=%27Stiff%20Opposition%20Expected%20to%20Casketless%20Funeral%20Plan%27\">click here</a>\n\n{$articleTitle|escape:'quotes'}\n\\'Stiff Opposition Expected to Casketless Funeral Plan\\'\n\n<a href=\"mailto:{$EmailAddress|escape:\"hex\"}\">{$EmailAddress|escape:\"hexentity\"}</a>\n{$EmailAddress|escape:'mail'} {* this converts to email to text *}\n<a href=\"mailto:%62%6f%..snip..%65%74\">bob..snip..et</a>\n\n{'mail@example.com'|escape:'mail'}\nsmarty [AT] example [DOT] com\n\n{* the \"rewind\" parameter registers the current location *}\n<a href=\"$my_path?page=foo&rewind={$my_uri|escape:url}\">click here</a>\nThis snippet is useful for emails, but see also {mailto}
{* email address mangled *}\n<a href=\"mailto:{$EmailAddress|escape:'hex'}\">{$EmailAddress|escape:'mail'}</a>\nSee also auto-escaping, escaping smarty parsing, {mailto} and the obfuscating email addresses pages.
from_charset is used to transcode a string from a given charset to the internal charset. This is the exact opposite of the to_charset modifier.
ISO-8859-1, UTF-8, and any character set supported by mb_convert_encoding() ISO-8859-1 The charset encoding the value is supposed to be decoded from Note
Charset encoding should be handled by the application itself. This modifier should only be used in cases where the application cannot anticipate that a certain string is required in another encoding.
See also Configuring Smarty, to_charset modifier.
"},{"location":"designers/language-modifiers/language-modifier-in_array/","title":"in_array","text":"test if value is contained in an array
"},{"location":"designers/language-modifiers/language-modifier-in_array/#basic-usage","title":"Basic usage","text":"{if in_array('value2', $myarray)} value2 is in myarray{/if}\nCan be replaced by operator is in
{if 'value2' is in $myarray}value2 is in myarray{/if}\nSee Also operators
"},{"location":"designers/language-modifiers/language-modifier-indent/","title":"indent","text":"This indents a string on each line, default is 4. As an optional parameter, you can specify the number of characters to indent. As an optional second parameter, you can specify the character to use to indent with. For example: use \"\\t\" for a tab.
{$myVar|indent:4}\n<?php\n\n$smarty->assign('articleTitle',\n 'NJ judge to rule on nude beach.\nSun or rain expected today, dark tonight.\nStatistics show that teen pregnancy drops off significantly after 25.'\n );\nWhere template is:
{$articleTitle}\n\n{$articleTitle|indent}\n\n{$articleTitle|indent:10}\n\n{$articleTitle|indent:1:\"\\t\"}\nWill output:
NJ judge to rule on nude beach.\nSun or rain expected today, dark tonight.\nStatistics show that teen pregnancy drops off significantly after 25.\n\n NJ judge to rule on nude beach.\n Sun or rain expected today, dark tonight.\n Statistics show that teen pregnancy drops off significantly after 25.\n\n NJ judge to rule on nude beach.\n Sun or rain expected today, dark tonight.\n Statistics show that teen pregnancy drops off significantly after 25.\n\n NJ judge to rule on nude beach.\n Sun or rain expected today, dark tonight.\n Statistics show that teen pregnancy drops off significantly after 25.\nSee also strip, wordwrap and spacify.
Return true if the variable passed to it is an array.
"},{"location":"designers/language-modifiers/language-modifier-is_array/#basic-usage","title":"Basic usage","text":"{if $myVar|is_array}it's an array{/if}\nReturns true if the variable(s) passed to it are different from null.
If multiple parameters are supplied then isset() will return true only if all of the parameters are not null.
"},{"location":"designers/language-modifiers/language-modifier-isset/#basic-usage","title":"Basic usage","text":"{if $myVar|isset}all set!{/if}\nReturns a string containing all the element of the given array with the separator string between each.
"},{"location":"designers/language-modifiers/language-modifier-join/#basic-usage","title":"Basic usage","text":"For $myArray populated with ['a','b','c'], the following will return the string abc.
{$myArray|join}\nFor $myArray populated with [1,2,3], the following will return the string 1-2-3.
{$myArray|join:\"-\"}\nTransforms a value into a valid JSON string.
"},{"location":"designers/language-modifiers/language-modifier-json-encode/#basic-usage","title":"Basic usage","text":"{$user|json_encode}\n$user this would return a string in JSON-format, e.g. {\"username\":\"my_username\",\"email\":\"my_username@smarty.net\"}."},{"location":"designers/language-modifiers/language-modifier-json-encode/#parameters","title":"Parameters","text":"Parameter Type Required Description 1 int No bitmask of flags, directly passed to PHP's json_encode"},{"location":"designers/language-modifiers/language-modifier-json-encode/#examples","title":"Examples","text":"By passing 16 as the second parameter, you can force json_encode to always format the JSON-string as an object. Without it, an array $myArray = [\"a\",\"b\"] would be formatted as a javascript array:
{$myArray|json_encode} # renders: [\"a\",\"b\"]\n{$myArray|json_encode:16} # renders: {\"0\":\"a\",\"1\":\"b\"}\nThis is used to lowercase a variable. This is equivalent to the PHP strtolower() function.
{$myVar|lower}\n<?php\n\n$smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.');\nWhere template is:
{$articleTitle}\n{$articleTitle|lower}\nThis will output:
Two Convicts Evade Noose, Jury Hung.\ntwo convicts evade noose, jury hung.\nSee also upper and capitalize.
All \"\\n\" line breaks will be converted to html <br /> tags in the given variable. This is equivalent to the PHP\\'s nl2br() function.
{$myVar|nl2br}\n<?php\n\n$smarty->assign('articleTitle',\n \"Sun or rain expected\\ntoday, dark tonight\"\n );\nWhere the template is:
{$articleTitle|nl2br}\nWill output:
Sun or rain expected<br />today, dark tonight\nSee also word_wrap, count_paragraphs and count_sentences.
Always returns an empty string. This can be used to call a function or a method on an object that returns output, and suppress the output.
"},{"location":"designers/language-modifiers/language-modifier-noprint/#basic-usage","title":"Basic usage","text":"{$controller->sendEmail()|noprint}\nAllows you to format a number using decimals and a thousands-separator. By default, the number of decimals is 0 and the number is rounded.
"},{"location":"designers/language-modifiers/language-modifier-number-format/#basic-usage","title":"Basic usage","text":"{$num = 2000.151}\n{$num|number_format} # renders: 2,000\n{$num = 2000.151}\n{$num|number_format:2} # renders: 2,000.15\n{$num = 2000.151}\n{$num|number_format:2:\".\":\"\"} # renders: 2000.15\nPrevents variable escaping when auto-escaping is activated.
"},{"location":"designers/language-modifiers/language-modifier-raw/#basic-usage","title":"Basic usage","text":"{$myVar|raw}\nA regular expression search and replace on a variable. Use the preg_replace() syntax from the PHP manual.
{$myVar|regex_replace:\"/foo/\":\"bar\"}\nNote
Although Smarty supplies this regex convenience modifier, it is usually better to apply regular expressions in PHP, either via custom functions or modifiers. Regular expressions are considered application code and are not part of presentation logic.
"},{"location":"designers/language-modifiers/language-modifier-regex-replace/#parameters","title":"Parameters","text":"Parameter Position Type Required Description 1 string Yes This is the regular expression to be replaced. 2 string Yes This is the string of text to replace with."},{"location":"designers/language-modifiers/language-modifier-regex-replace/#examples","title":"Examples","text":"<?php\n\n$smarty->assign('articleTitle', \"Infertility unlikely to\\nbe passed on, experts say.\");\nWhere template is:
{* replace each carriage return, tab and new line with a space *}\n\n{$articleTitle}\n{$articleTitle|regex_replace:\"/[\\r\\t\\n]/\":\" \"}\nWill output:
Infertility unlikely to\nbe passed on, experts say.\nInfertility unlikely to be passed on, experts say.\nSee also replace and escape.
A simple search and replace on a variable. This is equivalent to the PHP's str_replace() function.
{$myVar|replace:\"foo\":\"bar\"}\n<?php\n\n$smarty->assign('articleTitle', \"Child's Stool Great for Use in Garden.\");\nWhere template is:
{$articleTitle}\n{$articleTitle|replace:'Garden':'Vineyard'}\n{$articleTitle|replace:' ':' '}\nWill output:
Child's Stool Great for Use in Garden.\nChild's Stool Great for Use in Vineyard.\nChild's Stool Great for Use in Garden.\nSee also regex_replace and escape.
Rounds a number to the specified precision.
"},{"location":"designers/language-modifiers/language-modifier-round/#basic-usage","title":"Basic usage","text":"{3.14|round} # renders: 3\n{3.141592|round:2} # renders: 3.14\nIf 'precision' is negative, the number is rounded to the nearest power of 10. See examples below.
The parameter 'mode' defines how the rounding is done. By default, 2.5 is rounded to 3, whereas 2.45 is rounded to 2. You usually don't need to change this. For more details on rounding modes, see PHP's documentation on round.
"},{"location":"designers/language-modifiers/language-modifier-round/#examples","title":"Examples","text":"By passing 16 as the second parameter, you can force json_encode to always format the JSON-string as an object. Without it, an array $myArray = [\"a\",\"b\"] would be formatted as a javascript array:
{$myArray|json_encode} # renders: [\"a\",\"b\"]\n{$myArray|json_encode:16} # renders: {\"0\":\"a\",\"1\":\"b\"}\nspacify is a way to insert a space between every character of a variable. You can optionally pass a different character or string to insert.
{$myVar|spacify}\n<?php\n\n$smarty->assign('articleTitle', 'Something Went Wrong in Jet Crash, Experts Say.');\nWhere template is:
{$articleTitle}\n{$articleTitle|spacify}\n{$articleTitle|spacify:\"^^\"}\nWill output:
Something Went Wrong in Jet Crash, Experts Say.\nS o m e t h i n g W .... snip .... s h , E x p e r t s S a y .\nS^^o^^m^^e^^t^^h^^i^^n^^g^^ .... snip .... ^^e^^r^^t^^s^^ ^^S^^a^^y^^.\nSee also wordwrap and nl2br.
Splits a string into an array, using the optional second parameter as the separator.
"},{"location":"designers/language-modifiers/language-modifier-split/#basic-usage","title":"Basic usage","text":"For $chars populated with 'abc', the following will produce a html list with 3 elements (a, b and c).
<ol>\n {foreach $chars|split as $char}\n <li>{$char|escape}</li>\n {/foreach}\n</ol>\nFor $ids populated with '1,2,3', the following will produce a html list with 3 elements (1, 2 and 3).
<ol>\n {foreach $ids|split:',' as $id}\n <li>{$id|escape}</li>\n {/foreach}\n</ol>\nRepeats the given value n times.
"},{"location":"designers/language-modifiers/language-modifier-str-repeat/#basic-usage","title":"Basic usage","text":"{\"hi\"|str_repeat:2} # renders: hihi\nThis is a way to format strings, such as decimal numbers and such. Use the syntax for sprintf() for the formatting.
{$myVar|string_format:\"%d\"}\n<?php\n\n$smarty->assign('number', 23.5787446);\nWhere template is:
{$number}\n{$number|string_format:\"%.2f\"}\n{$number|string_format:\"%d\"}\nWill output:
23.5787446\n23.58\n23\nSee also date_format.
This strips out HTML markup tags, basically anything between < and >.
{$myVar|strip_tags}\n<?php\n\n$smarty->assign('articleTitle',\n \"Blind Woman Gets <font face=\\\"helvetica\\\">New\nKidney</font> from Dad she Hasn't Seen in <b>years</b>.\"\n );\nWhere template is:
{$articleTitle}\n{$articleTitle|strip_tags} {* same as {$articleTitle|strip_tags:true} *}\n{$articleTitle|strip_tags:false}\nWill output:
Blind Woman Gets <font face=\"helvetica\">New Kidney</font> from Dad she Hasn't Seen in <b>years</b>.\nBlind Woman Gets New Kidney from Dad she Hasn't Seen in years .\nBlind Woman Gets New Kidney from Dad she Hasn't Seen in years.\nSee also replace and regex_replace.
This replaces all spaces, newlines and tabs with a single space, or with the supplied string.
"},{"location":"designers/language-modifiers/language-modifier-strip/#basic-usage","title":"Basic usage","text":"{$myVar|strip}\nNote
If you want to strip blocks of template text, use the built-in {strip} function.
<?php\n$smarty->assign('articleTitle', \"Grandmother of\\neight makes\\t hole in one.\");\n$smarty->display('index.tpl');\nWhere template is:
{$articleTitle}\n{$articleTitle|strip}\n{$articleTitle|strip:' '}\nWill output:
Grandmother of\neight makes hole in one.\nGrandmother of eight makes hole in one.\nGrandmother of eight makes hole in one.\nSee also {strip} and truncate.
Returns the length (number of characters) in the given string, including spaces.
"},{"location":"designers/language-modifiers/language-modifier-strlen/#basic-usage","title":"Basic usage","text":"{\"Smarty\"|strlen} # renders: 6\n{156|strlen} # renders: 3\nReturns a part (substring) of the given string starting at a given offset.
"},{"location":"designers/language-modifiers/language-modifier-substr/#basic-usage","title":"Basic usage","text":"{\"Smarty\"|substr:2} # renders: arty\n{\"Smarty\"|substr:2:3} # renders: art\nWhen used with a negative offset, the substring starts n characters from the end of the string counting backwards.
{\"Smarty\"|substr:-2} # renders: ty\n{\"Smarty\"|substr:-2:1} # renders: t\nto_charset is used to transcode a string from the internal charset to a given charset. This is the exact opposite of the from_charset modifier.
ISO-8859-1, UTF-8, and any character set supported by mb_convert_encoding() ISO-8859-1 The charset encoding the value is supposed to be encoded to Note
Charset encoding should be handled by the application itself. This modifier should only be used in cases where the application cannot anticipate that a certain string is required in another encoding.
See also Configuring Smarty, from_charset modifier.
"},{"location":"designers/language-modifiers/language-modifier-truncate/","title":"truncate","text":"This truncates a variable to a character length, the default is 80. As an optional second parameter, you can specify a string of text to display at the end if the variable was truncated. The characters in the string are included with the original truncation length. By default, truncate will attempt to cut off at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter of TRUE.
{$myVar|truncate:40:\"...\"}\n<?php\n$smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.');\nwhere template is:
{$articleTitle}\n{$articleTitle|truncate}\n{$articleTitle|truncate:30}\n{$articleTitle|truncate:30:\"\"}\n{$articleTitle|truncate:30:\"---\"}\n{$articleTitle|truncate:30:\"\":true}\n{$articleTitle|truncate:30:\"...\":true}\n{$articleTitle|truncate:30:'..':true:true}\nThis will output:
Two Sisters Reunite after Eighteen Years at Checkout Counter.\nTwo Sisters Reunite after Eighteen Years at Checkout Counter.\nTwo Sisters Reunite after...\nTwo Sisters Reunite after\nTwo Sisters Reunite after---\nTwo Sisters Reunite after Eigh\nTwo Sisters Reunite after E...\nTwo Sisters Re..ckout Counter.\nunescape is used to decode entity, html and htmlall. It counters the effects of the escape modifier for the given types.
{$myVar|unescape}\nhtml, htmlall, entity, html This is the escape format to use. 2 string No ISO-8859-1, UTF-8, and any character set supported by htmlentities() UTF-8 The character set encoding passed to html_entity_decode() or htmlspecialchars_decode() or mb_convert_encoding() et. al."},{"location":"designers/language-modifiers/language-modifier-unescape/#examples","title":"Examples","text":"<?php\n\n$smarty->assign('articleTitle',\n \"Germans use "Ümlauts" and pay in €uro\"\n );\nThese are example unescape template lines followed by the output
{$articleTitle}\nGermans use "Ümlauts" and pay in €uro\n\n{$articleTitle|unescape:\"html\"}\nGermans use \"Ümlauts\" and pay in €uro\n\n{$articleTitle|unescape:\"htmlall\"}\nGermans use \"\u00dcmlauts\" and pay in \u20acuro\nSee also escaping smarty parsing, escape modifier.
"},{"location":"designers/language-modifiers/language-modifier-upper/","title":"upper","text":"This is used to uppercase a variable. This is equivalent to the PHP strtoupper() function.
{$myVar|upper}\n<?php\n$smarty->assign('articleTitle', \"If Strike isn't Settled Quickly it may Last a While.\");\nWhere template is:
{$articleTitle}\n{$articleTitle|upper}\nWill output:
If Strike isn't Settled Quickly it may Last a While.\nIF STRIKE ISN'T SETTLED QUICKLY IT MAY LAST A WHILE.\nSee also lower and capitalize.
Wraps a string to a column width, the default is 80. As an optional second parameter, you can specify a string of text to wrap the text to the next line, the default is a carriage return \"\\n\". By default, wordwrap will attempt to wrap at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter as TRUE. This is equivalent to the PHP wordwrap() function.
{$myVar|wordwrap:30}\n<?php\n\n$smarty->assign('articleTitle',\n \"Blind woman gets new kidney from dad she hasn't seen in years.\"\n );\nWhere template is
{$articleTitle}\n\n{$articleTitle|wordwrap:30}\n\n{$articleTitle|wordwrap:20}\n\n{$articleTitle|wordwrap:30:\"<br />\\n\"}\n\n{$articleTitle|wordwrap:26:\"\\n\":true}\nWill output:
Blind woman gets new kidney from dad she hasn't seen in years.\n\nBlind woman gets new kidney\nfrom dad she hasn't seen in\nyears.\n\nBlind woman gets new\nkidney from dad she\nhasn't seen in\nyears.\n\nBlind woman gets new kidney<br />\nfrom dad she hasn't seen in<br />\nyears.\n\nBlind woman gets new kidn\ney from dad she hasn't se\nen in years.\nSee also nl2br and {textformat}.
Smarty has several types of variables. The type of the variable depends on what symbol it is prefixed or enclosed within.
Variables in Smarty can be either displayed directly or used as arguments for tags, attributes and modifiers, inside conditional expressions, etc. To print a variable, simply enclose it in the delimiters so that it is the only thing contained between them.
{$Name}\n\n{$product.part_no} <b>{$product.description}</b>\n\n{$Contacts[row].Phone}\n\n<body bgcolor=\"{#bgcolor#}\">\nYou can assign variables to specific variable scopes.
Note
An easy way to examine assigned Smarty variables is with the debugging console.
"},{"location":"designers/language-variables/language-assigned-variables/","title":"Variables assigned from PHP","text":"Variables assigned from PHP are referenced by preceding them with a dollar ($) sign.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->assign('firstname', 'Doug');\n$smarty->assign('lastname', 'Evans');\n$smarty->assign('meetingPlace', 'New York');\n\n$smarty->display('index.tpl');\nindex.tpl source:
Hello {$firstname} {$lastname}, glad to see you can make it.\n<br />\n{* this will not work as $variables are case sensitive *}\nThis weeks meeting is in {$meetingplace}.\n{* this will work *}\nThis weeks meeting is in {$meetingPlace}.\nThis above would output:
Hello Doug Evans, glad to see you can make it.\n<br />\nThis weeks meeting is in .\nThis weeks meeting is in New York.\nYou can also reference associative array variables by specifying the key after a dot \".\" symbol.
<?php\n$smarty->assign('Contacts',\n array('fax' => '555-222-9876',\n 'email' => 'zaphod@slartibartfast.example.com',\n 'phone' => array('home' => '555-444-3333',\n 'cell' => '555-111-1234')\n )\n );\n$smarty->display('index.tpl');\nindex.tpl source:
{$Contacts.fax}<br />\n{$Contacts.email}<br />\n{* you can print arrays of arrays as well *}\n{$Contacts.phone.home}<br />\n{$Contacts.phone.cell}<br />\nthis will output:
555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\nYou can reference arrays by their index, much like native PHP syntax.
<?php\n$smarty->assign('Contacts', array(\n '555-222-9876',\n 'zaphod@slartibartfast.example.com',\n array('555-444-3333',\n '555-111-1234')\n ));\n$smarty->display('index.tpl');\nindex.tpl source:
{$Contacts[0]}<br />\n{$Contacts[1]}<br />\n{* you can print arrays of arrays as well *}\n{$Contacts[2][0]}<br />\n{$Contacts[2][1]}<br />\nThis will output:
555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\nProperties of objects assigned from PHP can be referenced by specifying the property name after the -> symbol.
name: {$person->name}<br />\nemail: {$person->email}<br />\nthis will output:
name: Zaphod Beeblebrox<br />\nemail: zaphod@slartibartfast.example.com<br />\nVariables that are loaded from the config files are referenced by enclosing them within #hash_marks#, or with the smarty variable $smarty.config. The later syntax is useful for embedding into quoted attribute values, or accessing variable values such as $smarty.config.$foo.
Example config file - foo.conf:
pageTitle = \"This is mine\"\nbodyBgColor = '#eeeeee'\ntableBorderSize = 3\ntableBgColor = \"#bbbbbb\"\nrowBgColor = \"#cccccc\"\nA template demonstrating the #hash# method:
{config_load file='foo.conf'}\n<html>\n <title>{#pageTitle#}</title>\n <body bgcolor=\"{#bodyBgColor#}\">\n <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n <tr bgcolor=\"{#rowBgColor#}\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nA template demonstrating the $smarty.config method:
{config_load file='foo.conf'}\n<html>\n<title>{$smarty.config.pageTitle}</title>\n <body bgcolor=\"{$smarty.config.bodyBgColor}\">\n <table border=\"{$smarty.config.tableBorderSize}\" bgcolor=\"{$smarty.config.tableBgColor}\">\n <tr bgcolor=\"{$smarty.config.rowBgColor}\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nBoth examples would output:
<html>\n <title>This is mine</title>\n <body bgcolor=\"#eeeeee\">\n <table border=\"3\" bgcolor=\"#bbbbbb\">\n <tr bgcolor=\"#cccccc\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nConfig file variables cannot be used until after they are loaded in from a config file. This procedure is explained later in this document under {config_load}.
See also variables and $smarty reserved variables.
"},{"location":"designers/language-variables/language-variable-scopes/","title":"Variable scopes","text":"You have the choice to assign variables to the scope of the main Smarty object, data objects created with createData(), and template objects created with createTemplate(). These objects can be chained. A template sees all the variables of its own object and all variables assigned to the objects in its chain of parent objects.
By default, templates which are rendered by $smarty->display(...) or $smarty->fetch(...) calls are automatically linked to the Smarty object variable scope.
By assigning variables to individual data or template objects you have full control which variables can be seen by a template.
<?php\n// assign variable to Smarty object scope\n$smarty->assign('foo','smarty');\n\n// assign variables to data object scope\n$data = $smarty->createData();\n$data->assign('foo','data');\n$data->assign('bar','bar-data');\n\n// assign variables to other data object scope\n$data2 = $smarty->createData($data);\n$data2->assign('bar','bar-data2');\n\n// assign variable to template object scope\n$tpl = $smarty->createTemplate('index.tpl');\n$tpl->assign('bar','bar-template');\n\n// assign variable to template object scope with link to Smarty object\n$tpl2 = $smarty->createTemplate('index.tpl',$smarty);\n$tpl2->assign('bar','bar-template2');\n\n// This display() does see $foo='smarty' from the $smarty object\n$smarty->display('index.tpl');\n\n// This display() does see $foo='data' and $bar='bar-data' from the data object $data\n$smarty->display('index.tpl',$data);\n\n// This display() does see $foo='data' from the data object $data \n// and $bar='bar-data2' from the data object $data2\n$smarty->display('index.tpl',$data2);\n\n// This display() does see $bar='bar-template' from the template object $tpl\n$tpl->display(); // or $smarty->display($tpl);\n\n// This display() does see $bar='bar-template2' from the template object $tpl2\n// and $foo='smarty' form the Smarty object $foo\n$tpl2->display(); // or $smarty->display($tpl2);\nSee also assign(), createData() and createTemplate().
The PHP reserved {$smarty} variable can be used to access several environment and request variables. The full list of them follows.
The request variables such as $_GET, $_POST, $_COOKIE, $_SERVER, $_ENV and $_SESSION can be accessed as demonstrated in the examples below:
{* display value of page from URL ($_GET) http://www.example.com/index.php?page=foo *}\n{$smarty.get.page}\n\n{* display the variable \"page\" from a form ($_POST['page']) *}\n{$smarty.post.page}\n\n{* display the value of the cookie \"username\" ($_COOKIE['username']) *}\n{$smarty.cookies.username}\n\n{* display the server variable \"SERVER_NAME\" ($_SERVER['SERVER_NAME'])*}\n{$smarty.server.SERVER_NAME}\n\n{* display the system environment variable \"PATH\" *}\n{$smarty.env.PATH}\n\n{* display the php session variable \"id\" ($_SESSION['id']) *}\n{$smarty.session.id}\n\n{* display the variable \"username\" from merged get/post/cookies/server/env *}\n{$smarty.request.username}\nNote
For historical reasons {$SCRIPT_NAME} is shorthand for {$smarty.server.SCRIPT_NAME}.
<a href=\"{$SCRIPT_NAME}?page=smarty\">click me</a>\n<a href=\"{$smarty.server.SCRIPT_NAME}?page=smarty\">click me</a>\nNote
Although Smarty provides direct access to PHP super globals for convenience, it should be used with caution. Directly accessing super globals mixes underlying application code structure with templates. A good practice is to assign specific needed values to template vars.
"},{"location":"designers/language-variables/language-variables-smarty/#smartynow","title":"{$smarty.now}","text":"The current timestamp can be accessed with {$smarty.now}. The value reflects the number of seconds passed since the so-called Epoch on January 1, 1970, and can be passed directly to the date_format modifier for display. Note that time() is called on each invocation; eg a script that takes three seconds to execute with a call to $smarty.now at start and end will show the three-second difference.
{* use the date_format modifier to show current date and time *}\n{$smarty.now|date_format:'%Y-%m-%d %H:%M:%S'}\nYou can access PHP constant values directly.
<?php\n// the constant defined in php\ndefine('MY_CONST_VAL','CHERRIES');\nOutput the constant in a template with
{$smarty.const.MY_CONST_VAL}\nNote
Although Smarty provides direct access to PHP constants for convenience, it is typically avoided as this is mixing underlying application code structure into the templates. A good practice is to assign specific needed values to template vars.
"},{"location":"designers/language-variables/language-variables-smarty/#smartycapture","title":"{$smarty.capture}","text":"Template output captured via the built-in {capture}..{/capture} function can be accessed using the {$smarty.capture} variable. See the {capture} page for more information.
{$smarty.config} variable can be used to refer to loaded config variables. {$smarty.config.foo} is a synonym for {#foo#}. See the {config_load} page for more info.
The {$smarty.section} variables can be used to refer to {section} loop properties. These have some very useful values such as .first, .index, etc.
Note
The {$smarty.foreach} variable is no longer used with the new {foreach} syntax, but is still supported with Smarty 2.x style foreach syntax.
Returns the name of the current template being processed (without the directory).
"},{"location":"designers/language-variables/language-variables-smarty/#smartytemplate_object","title":"{$smarty.template_object}","text":"Returns the template object of the current template being processed.
"},{"location":"designers/language-variables/language-variables-smarty/#smartycurrent_dir","title":"{$smarty.current_dir}","text":"Returns the name of the directory for the current template being processed if it is loaded from the filesystem (the default).
"},{"location":"designers/language-variables/language-variables-smarty/#smartyversion","title":"{$smarty.version}","text":"Returns the version of Smarty the template was compiled with.
<div id=\"footer\">Powered by Smarty {$smarty.version}</div>\nReturns block text from child template. See Template inheritance.
"},{"location":"designers/language-variables/language-variables-smarty/#smartyblockparent","title":"{$smarty.block.parent}","text":"Returns block text from parent template. See Template inheritance
"},{"location":"designers/language-variables/language-variables-smarty/#smartyldelim-smartyrdelim","title":"{$smarty.ldelim}, {$smarty.rdelim}","text":"These variables are used for printing the left-delimiter and right-delimiter value literally, the same as {ldelim},{rdelim}.
See also assigned variables and config variables
"},{"location":"programmers/api-functions/api-add-plugins-dir/","title":"Api add plugins dir","text":"addPluginsDir()
add a directory to the list of directories where plugins are stored
"},{"location":"programmers/api-functions/api-add-plugins-dir/#description","title":"Description","text":"Smarty
addPluginsDir
string|array
plugins_dir
<?php\n\n// add directory where plugins are stored\n$smarty->addPluginsDir('./plugins_1');\n\n// add multiple directories where plugins are stored\n$smarty->setPluginsDir(array(\n './plugins_2',\n './plugins_3',\n));\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// chaining of method calls\n$smarty->setPluginsDir('./plugins')\n ->addPluginsDir('./plugins_1')\n ->addPluginsDir('./plugins_2');\n\n?>\nSee also getPluginsDir(), setPluginsDir() and $plugins_dir.
append()
append an element to an assigned array
"},{"location":"programmers/api-functions/api-append/#description","title":"Description","text":"void
append
mixed
var
void
append
string
varname
mixed
var
bool
merge
If you append to a string value, it is converted to an array value and then appended to. You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs. If you pass the optional third parameter of TRUE, the value will be merged with the current array instead of appended.
NOTE.PARAMETER.MERGE
<?php\n// This is effectively the same as assign()\n$smarty->append('foo', 'Fred');\n// After this line, foo will now be seen as an array in the template\n$smarty->append('foo', 'Albert');\n\n$array = array(1 => 'one', 2 => 'two');\n$smarty->append('X', $array);\n$array2 = array(3 => 'three', 4 => 'four');\n// The following line will add a second element to the X array\n$smarty->append('X', $array2);\n\n// passing an associative array\n$smarty->append(array('city' => 'Lincoln', 'state' => 'Nebraska'));\n?>\nSee also assign() and getTemplateVars()
assign()
assign variables/objects to the templates
"},{"location":"programmers/api-functions/api-assign/#description","title":"Description","text":"void
assign
mixed
var
void
assign
string
varname
mixed
var
bool
nocache
You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs.
If you pass the optional third nocache parameter of TRUE, the variable is assigned as nocache variable. See Cacheability of Variables for details.
Note
When you assign/register objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.
<?php\n// passing name/value pairs\n$smarty->assign('Name', 'Fred');\n$smarty->assign('Address', $address);\n\n// passing an associative array\n$smarty->assign(array('city' => 'Lincoln', 'state' => 'Nebraska'));\n\n// passing an array\n$myArray = array('no' => 10, 'label' => 'Peanuts');\n$smarty->assign('foo',$myArray);\n\n// passing a row from a database (eg adodb)\n$sql = 'select id, name, email from contacts where contact ='.$id;\n$smarty->assign('contact', $db->getRow($sql));\n?>\nThese are accessed in the template with
{* note the vars are case sensitive like php *}\n{$Name}\n{$Address}\n{$city}\n{$state}\n\n{$foo.no}, {$foo.label}\n{$contact.id}, {$contact.name},{$contact.email}\nTo access more complex array assignments see {foreach} and {section}
See also getTemplateVars(), clearAssign(), append() and {assign}
clearAllAssign()
clears the values of all assigned variables
"},{"location":"programmers/api-functions/api-clear-all-assign/#description","title":"Description","text":"void
clearAllAssign
<?php\n// passing name/value pairs\n$smarty->assign('Name', 'Fred');\n$smarty->assign('Address', $address);\n\n// will output above\nprint_r( $smarty->getTemplateVars() );\n\n// clear all assigned variables\n$smarty->clearAllAssign();\n\n// will output nothing\nprint_r( $smarty->getTemplateVars() );\n\n?>\nSee also clearAssign(), clearConfig(), getTemplateVars(), assign() and append()
clearAllCache()
clears the entire template cache
"},{"location":"programmers/api-functions/api-clear-all-cache/#description","title":"Description","text":"void
clearAllCache
int
expire_time
As an optional parameter, you can supply a minimum age in seconds the cache files must be before they will get cleared.
Note
Since Smarty version 3.1.14 it is possible to delete cache files by their individual expiration time at creation by passing constant SMARTY::CLEAR_EXPIRED as expire_time parameter.
<?php\n// clear the entire cache\n$smarty->clearAllCache();\n\n// clears all files over one hour old\n$smarty->clearAllCache(3600);\n?>\nSee also clearCache(), isCached() and the caching page.
clearAssign()
clears the value of an assigned variable
"},{"location":"programmers/api-functions/api-clear-assign/#description","title":"Description","text":"void
clearAssign
mixed
var
This can be a single value, or an array of values.
<?php\n// clear a single variable\n$smarty->clearAssign('Name');\n\n// clears multiple variables\n$smarty->clearAssign(array('Name', 'Address', 'Zip'));\n?>\nSee also clearAllAssign(), clearConfig(), getTemplateVars(), assign() and append()
clearCache()
clears the cache for a specific template
"},{"location":"programmers/api-functions/api-clear-cache/#description","title":"Description","text":"void
clearCache
string
template
string
cache_id
string
compile_id
int
expire_time
If you have multiple caches for a template, you can clear a specific cache by supplying the cache_id as the second parameter.
You can also pass a $compile_id as a third parameter. You can group templates together so they can be removed as a group, see the caching section for more information.
As an optional fourth parameter, you can supply a minimum age in seconds the cache file must be before it will get cleared.
Note
Since Smarty version 3.1.14 it is possible to delete cache files by their individual expiration time at creation by passing constant SMARTY::CLEAR_EXPIRED as fourth parameter.
<?php\n// clear the cache for a template\n$smarty->clearCache('index.tpl');\n\n// clear the cache for a particular cache id in an multiple-cache template\n$smarty->clearCache('index.tpl', 'MY_CACHE_ID');\n?>\nSee also clearAllCache() and caching section.
clearCompiledTemplate()
clears the compiled version of the specified template resource
"},{"location":"programmers/api-functions/api-clear-compiled-tpl/#description","title":"Description","text":"void
clearCompiledTemplate
string
tpl_file
string
compile_id
int
exp_time
This clears the compiled version of the specified template resource, or all compiled template files if one is not specified. If you pass a $compile_id only the compiled template for this specific $compile_id is cleared. If you pass an exp_time, then only compiled templates older than exp_time seconds are cleared, by default all compiled templates are cleared regardless of their age. This function is for advanced use only, not normally needed.
<?php\n// clear a specific template resource\n$smarty->clearCompiledTemplate('index.tpl');\n\n// clear entire compile directory\n$smarty->clearCompiledTemplate();\n?>\nSee also clearCache().
clearConfig()
clears assigned config variables
"},{"location":"programmers/api-functions/api-clear-config/#description","title":"Description","text":"void
clearConfig
string
var
This clears all assigned config variables. If a variable name is supplied, only that variable is cleared.
<?php\n// clear all assigned config variables.\n$smarty->clearConfig();\n\n// clear one variable\n$smarty->clearConfig('foobar');\n?>\nSee also getConfigVars(), config variables, config files, {config_load}, configLoad() and clearAssign().
compileAllConfig()
compiles all known config files
"},{"location":"programmers/api-functions/api-compile-all-config/#description","title":"Description","text":"string
compileAllConfig
string
extension
boolean
force
integer
timelimit
integer
maxerror
This function compiles config files found in the $config_dir folder. It uses the following parameters:
extension is an optional string which defines the file extension for the config files. The default is \\\".conf\\\".
force is an optional boolean which controls if only modified (false) or all (true) config files shall be compiled. The default is \\\"false\\\".
timelimit is an optional integer to set a runtime limit in seconds for the compilation process. The default is no limit.
maxerror is an optional integer to set an error limit. If more config files failed to compile the function will be aborted. The default is no limit.
Note
This function may not create desired results in all configurations. Use is on own risk.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// force compilation of all config files\n$smarty->compileAllConfig('.config',true);\n\n?>\ncompileAllTemplates()
compiles all known templates
"},{"location":"programmers/api-functions/api-compile-all-templates/#description","title":"Description","text":"string
compileAllTemplates
string
extension
boolean
force
integer
timelimit
integer
maxerror
This function compiles template files found in the $template_dir folder. It uses the following parameters:
extension is an optional string which defines the file extension for the template files. The default is \\\".tpl\\\".
force is an optional boolean which controls if only modified (false) or all (true) templates shall be compiled. The default is \\\"false\\\".
timelimit is an optional integer to set a runtime limit in seconds for the compilation process. The default is no limit.
maxerror is an optional integer to set an error limit. If more templates failed to compile the function will be aborted. The default is no limit.
Note
This function may not create desired results in all configurations. Use is on own risk.
Note
If any template requires registered plugins, filters or objects you must register all of them before running this function.
Note
If you are using template inheritance this function will create compiled files of parent templates which will never be used.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// force compilation of all template files\n$smarty->compileAllTemplates('.tpl',true);\n\n?>\nconfigLoad()
loads config file data and assigns it to the template
"},{"location":"programmers/api-functions/api-config-load/#description","title":"Description","text":"void
configLoad
string
file
string
section
This loads config file data and assigns it to the template. This works identically to the template {config_load} function.
Note
As of Smarty 2.4.0, assigned template variables are kept across invocations of fetch() and display(). Config vars loaded from configLoad() are always global in scope. Config files are also compiled for faster execution, and respect the $force_compile and $compile_check settings.
<?php\n// load config variables and assign them\n$smarty->configLoad('my.conf');\n\n// load a section\n$smarty->configLoad('my.conf', 'foobar');\n?>\nSee also {config_load}, getConfigVars(), clearConfig(), and config variables
createData()
creates a data object
"},{"location":"programmers/api-functions/api-create-data/#description","title":"Description","text":"string
createData
object
parent
string
createData
This creates a data object which will hold assigned variables. It uses the following parameters:
parent is an optional parameter. It is an uplink to the main Smarty object, a another user-created data object or to user-created template object. These objects can be chained. Templates can access variables assigned to any of the objects in it\\'s parent chain.Data objects are used to create scopes for assigned variables. They can be used to control which variables are seen by which templates.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// create data object with its private variable scope\n$data = $smarty->createData();\n\n// assign variable to data scope\n$data->assign('foo','bar');\n\n// create template object which will use variables from data object\n$tpl = $smarty->createTemplate('index.tpl',$data);\n\n// display the template\n$tpl->display();\n?>\nSee also display(), and createTemplate(),
createTemplate()
returns a template object
"},{"location":"programmers/api-functions/api-create-template/#description","title":"Description","text":"Smarty_Internal_Template
createTemplate
string
template
object
parent
Smarty_Internal_Template
createTemplate
string
template
array
data
Smarty_Internal_Template
createTemplate
string
template
string
cache_id
string
compile_id
object
parent
Smarty_Internal_Template
createTemplate
string
template
string
cache_id
string
compile_id
array
data
This creates a template object which later can be rendered by the display or fetch method. It uses the following parameters:
template must be a valid template resource type and path.<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// create template object with its private variable scope\n$tpl = $smarty->createTemplate('index.tpl');\n\n// assign variable to template scope\n$tpl->assign('foo','bar');\n\n// display the template\n$tpl->display();\n?>\nSee also display(), and templateExists().
disableSecurity()
disables template security
"},{"location":"programmers/api-functions/api-disable-security/#description","title":"Description","text":"string
disableSecurity
This disables security checking on templates.
See also enableSecurity(), and Security.
display()
displays the template
"},{"location":"programmers/api-functions/api-display/#description","title":"Description","text":"void
display
string
template
string
cache_id
string
compile_id
This displays the contents of a template. To return the contents of a template into a variable, use fetch(). Supply a valid template resource type and path. As an optional second parameter, you can pass a $cache_id, see the caching section for more information.
PARAMETER.COMPILEID
<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n$smarty->setCaching(true);\n\n// only do db calls if cache doesn't exist\nif(!$smarty->isCached('index.tpl')) {\n\n // dummy up some data\n $address = '245 N 50th';\n $db_data = array(\n 'City' => 'Lincoln',\n 'State' => 'Nebraska',\n 'Zip' => '68502'\n );\n\n $smarty->assign('Name', 'Fred');\n $smarty->assign('Address', $address);\n $smarty->assign('data', $db_data);\n\n}\n\n// display the output\n$smarty->display('index.tpl');\n?>\nUse the syntax for template resources to display files outside of the $template_dir directory.
<?php\n// absolute filepath\n$smarty->display('/usr/local/include/templates/header.tpl');\n\n// absolute filepath (same thing)\n$smarty->display('file:/usr/local/include/templates/header.tpl');\n\n// windows absolute filepath (MUST use \"file:\" prefix)\n$smarty->display('file:C:/www/pub/templates/header.tpl');\n\n// include from template resource named \"db\"\n$smarty->display('db:header.tpl');\n?>\nSee also fetch() and templateExists().
enableSecurity()
enables template security
"},{"location":"programmers/api-functions/api-enable-security/#description","title":"Description","text":"string
enableSecurity
string
securityclass
string
enableSecurity
object
securityobject
string
enableSecurity
This enables security checking on templates. It uses the following parameters:
securityclass is an optional parameter. It\\'s the name of the class with defines the security policy parameters.
securityobject is an optional parameter. It\\'s the object with defines the security policy parameters.
For the details how to setup a security policy see the Security section.
See also disableSecurity(), and Security.
fetch()
returns the template output
"},{"location":"programmers/api-functions/api-fetch/#description","title":"Description","text":"string
fetch
string
template
string
cache_id
string
compile_id
This returns the template output instead of displaying it. Supply a valid template resource type and path. As an optional second parameter, you can pass a $cache id, see the caching section for more information.
PARAMETER.COMPILEID
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(true);\n\n// set a separate cache_id for each unique URL\n$cache_id = md5($_SERVER['REQUEST_URI']);\n\n// capture the output\n$output = $smarty->fetch('index.tpl', $cache_id);\n\n// do something with $output here\necho $output;\n?>\nThe email_body.tpl template
Dear {$contact_info.name},\n\nWelcome and thank you for signing up as a member of our user group.\n\nClick on the link below to login with your user name\nof '{$contact_info.username}' so you can post in our forums.\n\n{$login_url}\n\nList master\n\n{textformat wrap=40}\nThis is some long-winded disclaimer text that would automatically get wrapped\nat 40 characters. This helps make the text easier to read in mail programs that\ndo not wrap sentences for you.\n{/textformat}\nThe php script using the PHP mail() function
<?php\n\n// get $contact_info from db or other resource here\n\n$smarty->assign('contact_info',$contact_info);\n$smarty->assign('login_url',\"http://{$_SERVER['SERVER_NAME']}/login\");\n\nmail($contact_info['email'], 'Thank You', $smarty->fetch('email_body.tpl'));\n\n?>\nSee also {fetch} display(), {eval}, and templateExists().
getConfigDir()
return the directory where config files are stored
"},{"location":"programmers/api-functions/api-get-config-dir/#description","title":"Description","text":"string|array
getConfigDir
string
key
<?php\n\n// set some config directories\n$smarty->setConfigDir(array(\n 'one' => './config',\n 'two' => './config_2',\n 'three' => './config_3',\n));\n\n// get all directories where config files are stored\n$config_dir = $smarty->getConfigDir();\nvar_dump($config_dir); // array\n\n// get directory identified by key\n$config_dir = $smarty->getConfigDir('one');\nvar_dump($config_dir); // string\n\n?>\nSee also setConfigDir(), addConfigDir() and $config_dir.
getConfigVars()
returns the given loaded config variable value
"},{"location":"programmers/api-functions/api-get-config-vars/#description","title":"Description","text":"array
getConfigVars
string
varname
If no parameter is given, an array of all loaded config variables is returned.
<?php\n\n// get loaded config template var #foo#\n$myVar = $smarty->getConfigVars('foo');\n\n// get all loaded config template vars\n$all_config_vars = $smarty->getConfigVars();\n\n// take a look at them\nprint_r($all_config_vars);\n?>\nSee also clearConfig(), {config_load}, configLoad() and getTemplateVars().
getPluginsDir()
return the directory where plugins are stored
"},{"location":"programmers/api-functions/api-get-plugins-dir/#description","title":"Description","text":"array
getPluginsDir
<?php\n\n// set some plugins directories\n$smarty->setPluginsDir(array(\n './plugins',\n './plugins_2',\n));\n\n// get all directories where plugins are stored\n$config_dir = $smarty->getPluginsDir();\nvar_dump($config_dir); // array\n\n?>\nSee also setPluginsDir(), addPluginsDir() and $plugins_dir.
getRegisteredObject()
returns a reference to a registered object
"},{"location":"programmers/api-functions/api-get-registered-object/#description","title":"Description","text":"array
getRegisteredObject
string
object_name
This is useful from within a custom function when you need direct access to a registered object. See the objects page for more info.
<?php\nfunction smarty_block_foo($params, $smarty)\n{\n if (isset($params['object'])) {\n // get reference to registered object\n $obj_ref = $smarty->getRegisteredObject($params['object']);\n // use $obj_ref is now a reference to the object\n }\n}\n?>\nSee also registerObject(), unregisterObject() and objects page
getTemplateVars()
returns assigned variable value(s)
"},{"location":"programmers/api-functions/api-get-template-vars/#description","title":"Description","text":"array
getTemplateVars
string
varname
If no parameter is given, an array of all assigned variables are returned.
<?php\n// get assigned template var 'foo'\n$myVar = $smarty->getTemplateVars('foo');\n\n// get all assigned template vars\n$all_tpl_vars = $smarty->getTemplateVars();\n\n// take a look at them\nprint_r($all_tpl_vars);\n?>\nSee also assign(), {assign}, append(), clearAssign(), clearAllAssign() and getConfigVars()
isCached()
returns true if there is a valid cache for this template
"},{"location":"programmers/api-functions/api-is-cached/#description","title":"Description","text":"bool
isCached
string
template
string
cache_id
string
compile_id
This only works if $caching is set to one of \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT or \\Smarty\\Smarty::CACHING_LIFETIME_SAVED to enable caching. See the caching section for more info.
You can also pass a $cache_id as an optional second parameter in case you want multiple caches for the given template.
You can supply a $compile id as an optional third parameter. If you omit that parameter the persistent $compile_id is used if its set.
If you do not want to pass a $cache_id but want to pass a $compile_id you have to pass NULL as a $cache_id.
Note
If isCached() returns TRUE it actually loads the cached output and stores it internally. Any subsequent call to display() or fetch() will return this internally stored output and does not try to reload the cache file. This prevents a race condition that may occur when a second process clears the cache between the calls to isCached() and to display() in the example above. This also means calls to clearCache() and other changes of the cache-settings may have no effect after isCached() returned TRUE.
<?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl')) {\n// do database calls, assign vars here\n}\n\n$smarty->display('index.tpl');\n?>\n\n\n\n\n<?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl', 'FrontPage')) {\n // do database calls, assign vars here\n}\n\n$smarty->display('index.tpl', 'FrontPage');\n?>\nSee also clearCache(), clearAllCache(), and caching section.
loadFilter()
load a filter plugin
"},{"location":"programmers/api-functions/api-load-filter/#description","title":"Description","text":"void
loadFilter
string
type
string
name
The first argument specifies the type of the filter to load and can be one of the following: variable, pre, post or output. The second argument specifies the name of the filter plugin.
<?php\n\n// load prefilter named 'trim'\n$smarty->loadFilter('pre', 'trim');\n\n// load another prefilter named 'datefooter'\n$smarty->loadFilter('pre', 'datefooter');\n\n// load output filter named 'compress'\n$smarty->loadFilter('output', 'compress');\n\n?>\nSee also registerFilter() and advanced features.
mutes expected warnings and notices deliberately generated by Smarty
"},{"location":"programmers/api-functions/api-mute-expected-errors/#description","title":"Description","text":"string
muteExpectedErrors
muteExpectedErrors() registers a custom error handler using set_error_handler(). The error handler merely inspects $errno and $errfile to determine if the given error was produced deliberately and must be ignored, or should be passed on to the next error handler.
\\Smarty\\Smarty::unmuteExpectedErrors() removes the current error handler. Please note, that if you\\'ve registered any custom error handlers after the muteExpectedErrors() call, the unmute will not remove Smarty\\'s muting error handler, but the one registered last.
registerCacheResource()
dynamically register CacheResources
"},{"location":"programmers/api-functions/api-register-cacheresource/#description","title":"Description","text":"void
registerCacheResource
string
name
Smarty_CacheResource
resource_handler
Use this to dynamically register a CacheResource plugin with Smarty. Pass in the name of the CacheResource and the object extending Smarty_CacheResource. See Custom Cache Implementation for more information on how to create custom CacheResources.
Note
In Smarty2 this used to be a callback function called $cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.
<?php\n$smarty->registerCacheResource('mysql', new My_CacheResource_Mysql());\n?>\nSee also unregisterCacheResource() and the Custom CacheResource Implementation section.
registerClass()
register a class for use in the templates
"},{"location":"programmers/api-functions/api-register-class/#description","title":"Description","text":"void
registerClass
string
class_name
string
class_impl
Smarty allows you to access static classes from templates as long as the Security Policy does not tell it otherwise. If security is enabled, classes registered with registerClass() are accessible to templates.
<?php\nuse Smarty\\Smarty;\n\nclass Bar {\n $property = \"hello world\";\n}\n\n$smarty = new Smarty();\n$smarty->registerClass(\"Foo\", \"Bar\");\n\n\n\n\n{* Smarty will access this class as long as it's not prohibited by security *}\n{Bar::$property}\n{* Foo translates to the real class Bar *}\n{Foo::$property}\n\n\n\n\n<?php\nuse Smarty\\Smarty;\n\nnamespace my\\php\\application {\n class Bar {\n $property = \"hello world\";\n }\n}\n\n$smarty = new Smarty();\n$smarty->registerClass(\"Foo\", \"\\my\\php\\application\\Bar\");\n\n\n\n\n{* Foo translates to the real class \\my\\php\\application\\Bar *}\n{Foo::$property}\nSee also registerObject(), and Security.
registerDefaultPluginHandler()
register a function which gets called on undefined tags
"},{"location":"programmers/api-functions/api-register-default-plugin-handler/#description","title":"Description","text":"void
registerDefaultPluginHandler
mixed
callback
Register a default plugin handler which gets called if the compiler can not find a definition for a tag otherwise. It uses the following parameters:
If during compilation Smarty encounters tag which is not defined internal, registered or located in the plugins folder it tries to resolve it by calling the registered default plugin handler. The handler may be called several times for same undefined tag looping over valid plugin types.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->registerDefaultPluginHandler('my_plugin_handler');\n\n/**\n * Default Plugin Handler\n *\n * called when Smarty encounters an undefined tag during compilation\n * \n * @param string $name name of the undefined tag\n * @param string $type tag type (e.g. Smarty::PLUGIN_FUNCTION, Smarty::PLUGIN_BLOCK, \n Smarty::PLUGIN_COMPILER, Smarty::PLUGIN_MODIFIER, Smarty::PLUGIN_MODIFIERCOMPILER)\n * @param \\Smarty\\Template\\ $template template object\n * @param string &$callback returned function name \n * @param string &$script optional returned script filepath if function is external\n * @param bool &$cacheable true by default, set to false if plugin is not cachable (Smarty >= 3.1.8)\n * @return bool true if successfull\n */\nfunction my_plugin_handler ($name, $type, $template, &$callback, &$script, &$cacheable)\n{\n switch ($type) {\n case Smarty::PLUGIN_FUNCTION:\n switch ($name) {\n case 'scriptfunction':\n $script = './scripts/script_function_tag.php';\n $callback = 'default_script_function_tag';\n return true;\n case 'localfunction':\n $callback = 'default_local_function_tag';\n return true;\n default:\n return false;\n }\n case Smarty::PLUGIN_COMPILER:\n switch ($name) {\n case 'scriptcompilerfunction':\n $script = './scripts/script_compiler_function_tag.php';\n $callback = 'default_script_compiler_function_tag';\n return true;\n default:\n return false;\n }\n case Smarty::PLUGIN_BLOCK:\n switch ($name) {\n case 'scriptblock':\n $script = './scripts/script_block_tag.php';\n $callback = 'default_script_block_tag';\n return true;\n default:\n return false;\n }\n default:\n return false;\n }\n }\n\n?>\nNote
The return callback must be static; a function name or an array of class and method name.
Dynamic callbacks like objects methods are not supported.
"},{"location":"programmers/api-functions/api-register-filter/","title":"Api register filter","text":"registerFilter()
dynamically register filters
"},{"location":"programmers/api-functions/api-register-filter/#description","title":"Description","text":"void
registerFilter
string
type
mixed
callback
Use this to dynamically register filters to operate on a templates. It uses the following parameters:
NOTE.PARAMETER.FUNCTION
A prefilter runs through the template source before it gets compiled. See template prefilters for more information on how to setup a prefiltering function.
A postfilter runs through the template code after it was compiled to PHP. See template postfilters for more information on how to setup a postfiltering function.
A outputfilter operates on a template\\'s output before it is displayed. See template output filters for more information on how to set up an output filter function.
See also unregisterFilter(), loadFilter(), template pre filters template post filters template output filters section.
registerObject()
register an object for use in the templates
"},{"location":"programmers/api-functions/api-register-object/#description","title":"Description","text":"void
registerObject
string
object_name
object
object
array
allowed_methods_properties
boolean
format
array
block_methods
Note
When you register/assign objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.
See the objects section for more information.
See also getRegisteredObject(), and unregisterObject().
registerPlugin()
dynamically register plugins
"},{"location":"programmers/api-functions/api-register-plugin/#description","title":"Description","text":"void
registerPlugin
string
type
string
name
mixed
callback
bool
cacheable
mixed
cache_attrs
This method registers functions or methods defined in your script as plugin. It uses the following parameters:
cacheable can be omitted in most cases. See controlling cacheability of plugins output on how to use this properly.<?php\n$smarty->registerPlugin(\"function\",\"date_now\", \"print_current_date\");\n\nfunction print_current_date($params, $smarty)\n{\n if(empty($params[\"format\"])) {\n $format = \"%b %e, %Y\";\n } else {\n $format = $params[\"format\"];\n }\n return strftime($format,time());\n}\n?>\nAnd in the template
{date_now}\n\n{* or to format differently *}\n{date_now format=\"%Y/%m/%d\"}\n\n\n<?php\n// function declaration\nfunction do_translation ($params, $content, $smarty, &$repeat, $template)\n{\n if (isset($content)) {\n $lang = $params[\"lang\"];\n // do some translation with $content\n return $translation;\n }\n}\n\n// register with smarty\n$smarty->registerPlugin(\"block\",\"translate\", \"do_translation\");\n?>\nWhere the template is:
{translate lang=\"br\"}Hello, world!{/translate}\n\n\n\n\n<?php\n\n// let's map PHP's stripslashes function to a Smarty modifier.\n$smarty->registerPlugin(\"modifier\",\"ss\", \"stripslashes\");\n\n?>\nIn the template, use ss to strip slashes.
<?php\n{$var|ss}\n?>\nSee also unregisterPlugin(), plugin functions, plugin block functions, plugin compiler functions, and the creating plugin modifiers section.
registerResource()
dynamically register resources
"},{"location":"programmers/api-functions/api-register-resource/#description","title":"Description","text":"void
registerResource
string
name
Smarty_resource
resource_handler
Use this to dynamically register a Resource plugin with Smarty. Pass in the name of the Resource and the object extending Smarty_Resource. See template resources for more information on how to setup a function for fetching templates.
Note
A resource name must be at least two characters in length. One character resource names will be ignored and used as part of the file path, such as $smarty->display('c:/path/to/index.tpl');
Note
Prior to Smarty 3.1 registerResource() accepted an array of callback functions. While this is still possible for backward compatibility reasons, it is strongly discouraged as callback functions have been deprecated as of Smarty 3.1.
<?php\n$smarty->registerResource('mysql', new My_Resource_Mysql());\n?>\nSee also unregisterResource() and the template resources section.
setPluginsDir()
set the directories where plugins are stored
"},{"location":"programmers/api-functions/api-set-plugins-dir/#description","title":"Description","text":"Smarty
setPluginsDir
string|array
plugins_dir
<?php\n\n// set a single directory where the plugins are stored\n$smarty->setPluginsDir('./plugins');\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// set multiple director\u00edes where plugins are stored\n$smarty->setPluginsDir(array(\n './plugins',\n './plugins_2',\n));\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n ->setPluginsDir('./plugins')\n ->setCompileDir('./templates_c')\n ->setCacheDir('./cache');\n\n?>\nSee also getPluginsDir(), addPluginsDir() and $plugins_dir.
testInstall()
checks Smarty installation
"},{"location":"programmers/api-functions/api-test-install/#description","title":"Description","text":"void
testInstall
This function verifies that all required working folders of the Smarty installation can be accessed. It does output a corresponding protocol.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->testInstall();\n?>\nunregisterCacheResource()
dynamically unregister a CacheResource plugin
"},{"location":"programmers/api-functions/api-unregister-cacheresource/#description","title":"Description","text":"void
unregisterCacheResource
string
name
Pass in the name of the CacheResource.
<?php\n\n$smarty->unregisterCacheResource('mysql');\n\n?>\nSee also registerCacheResource() and the Custom CacheResource Implementation section.
unregisterFilter()
dynamically unregister a filter
"},{"location":"programmers/api-functions/api-unregister-filter/#description","title":"Description","text":"void
unregisterFilter
string
type
string|array
callback
Use this to dynamically unregister filters. It uses the following parameters:
See also registerFilter().
unregisterObject()
dynamically unregister an object
"},{"location":"programmers/api-functions/api-unregister-object/#description","title":"Description","text":"void
unregisterObject
string
object_name
See also registerObject() and objects section
unregisterPlugin
dynamically unregister plugins
"},{"location":"programmers/api-functions/api-unregister-plugin/#description","title":"Description","text":"void
unregisterPlugin
string
type
string
name
This method unregisters plugins which previously have been registered by registerPlugin(), It uses the following parameters:
<?php\n\n// we don't want template designers to have access to function plugin \"date_now\" \n$smarty->unregisterPlugin(\"function\",\"date_now\");\n\n?>\nSee also registerPlugin().
unregisterResource()
dynamically unregister a resource plugin
"},{"location":"programmers/api-functions/api-unregister-resource/#description","title":"Description","text":"void
unregisterResource
string
name
Pass in the name of the resource.
<?php\n\n$smarty->unregisterResource('db');\n\n?>\nSee also registerResource() and template resources
The Smarty delimiter tags { and } will be ignored so long as they are surrounded by white space. This behavior can be disabled by setting auto_literal to false.
::: {.informalexample}
<?php\n$smarty->auto_literal = false;\n?>\n:::
See also Escaping Smarty parsing,
"},{"location":"programmers/api-variables/variable-cache-dir/","title":"\\$cache_dir {#variable.cache.dir}","text":"This is the name of the directory where template caches are stored. By default this is ./cache, meaning that Smarty will look for the cache/ directory in the same directory as the executing php script. This directory must be writeable by the web server, see install for more info.
You can also use your own custom cache implementation to control cache files, which will ignore this setting. See also $use_sub_dirs.
Note
This setting must be either a relative or absolute path. include_path is not used for writing files.
Note
It is not recommended to put this directory under the web server document root.
Note
As of Smarty 3.1 the attribute \\$cache_dir is no longer accessible directly. Use getCacheDir() and setCacheDir() instead.
See also getCacheDir(), setCacheDir(), $caching, $use_sub_dirs, $cache_lifetime, $cache_modified_check and the caching section.
Persistent cache_id identifier. As an alternative to passing the same $cache_id to each and every function call, you can set this $cache_id and it will be used implicitly thereafter.
With a $cache_id you can have multiple cache files for a single call to display() or fetch() depending for example from different content of the same template. See the caching section for more information.
This is the length of time in seconds that a template cache is valid. Once this time has expired, the cache will be regenerated.
$caching must be turned on (either \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT or \\Smarty\\Smarty::CACHING_LIFETIME_SAVED) for $cache_lifetime to have any purpose.
A $cache_lifetime value of -1 will force the cache to never expire.
A value of 0 will cause the cache to always regenerate (good for testing only, to disable caching a more efficient method is to set $caching = \\Smarty\\Smarty::CACHING_OFF).
If you want to give certain templates their own cache lifetime, you could do this by setting $caching = \\Smarty\\Smarty::CACHING_LIFETIME_SAVED, then set $cache_lifetime to a unique value just before calling display() or fetch().
If $force_compile is enabled, the cache files will be regenerated every time, effectively disabling caching. You can clear all the cache files with the clear_all_cache() function, or individual cache files (or groups) with the clear_cache() function.
Cache locking avoids concurrent cache generation. This means resource intensive pages can be generated only once, even if they\\'ve been requested multiple times in the same moment.
Cache locking is disabled by default. To enable it set $cache_locking to TRUE.
See also $locking_timeout
If set to TRUE, Smarty will respect the If-Modified-Since header sent from the client. If the cached file timestamp has not changed since the last visit, then a '304: Not Modified' header will be sent instead of the content.
See also $caching, $cache_lifetime, and the caching section.
This property specifies the name of the caching handler to use. It defaults to file, enabling the internal filesystem based cache handler.
See Custom Cache Implementation for pointers on setting up your own cache handler.
"},{"location":"programmers/api-variables/variable-caching/","title":"\\$caching {#variable.caching}","text":"This tells Smarty whether or not to cache the output of the templates to the $cache_dir. By default this is set to the constant \\Smarty\\Smarty::CACHING_OFF. If your templates consistently generate the same content, it is advisable to turn on $caching, as this may result in significant performance gains.
You can also have multiple caches for the same template.
A constant value of \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT or \\Smarty\\Smarty ::CACHING_LIFETIME_SAVED enables caching.
A value of \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT tells Smarty to use the current $cache_lifetime variable to determine if the cache has expired.
A value of \\Smarty\\Smarty::CACHING_LIFETIME_SAVED tells Smarty to use the $cache_lifetime value at the time the cache was generated. This way you can set the $cache_lifetime just before fetching the template to have granular control over when that particular cache expires. See also isCached().
If $compile_check is enabled, the cached content will be regenerated if any of the templates or config files that are part of this cache are changed.
If $force_compile is enabled, the cached content will always be regenerated.
See also $cache_dir, $cache_lifetime, $cache_modified_check, is_cached() and the caching section.
This is the name of the directory where compiled templates are located. By default this is ./templates_c, meaning that Smarty will look for the templates_c/ directory in the same directory as the executing php script. This directory must be writeable by the web server, see install for more info.
Note
This setting must be either a relative or absolute path. include_path is not used for writing files.
Note
It is not recommended to put this directory under the web server document root.
Note
As of Smarty 3.1 the attribute \\$compile_dir is no longer accessible directly. Use getCompileDir() and setCompileDir() instead.
See also getCompileDir(), setCompileDir(), $compile_id and $use_sub_dirs.
Persistent compile identifier. As an alternative to passing the same $compile_id to each and every function call, you can set this $compile_id and it will be used implicitly thereafter.
If you use the same template with different pre- and/or post-filters you must use a unique $compile_id to keep the compiled template files separated.
For example a prefilter that localizes your templates (that is: translates language dependent parts) at compile time, then you could use the current language as $compile_id and you will get a set of compiled templates for each language you use.
<?php\n$smarty->compile_id = 'en';\n?>\nAnother application would be to use the same compile directory across multiple domains / multiple virtual hosts.
<?php\n\n$smarty->compile_id = $_SERVER['SERVER_NAME'];\n$smarty->compile_dir = '/path/to/shared_compile_dir';\n\n?>\nNote
In Smarty 3 a $compile_id is no longer required to keep templates with same name in different $template_dir folders separated. The $template_dir file path is encoded in the file name of compiled and cached template files.
Compile locking avoids concurrent compilation of the same template.
Compile locking is enabled by default. To disable it set $compile_locking to FALSE.
Specifies the name of the compiler class that Smarty will use to compile the templates. The default is \\'Smarty_Compiler\\'. For advanced users only.
"},{"location":"programmers/api-variables/variable-config-booleanize/","title":"\\$config_booleanize {#variable.config.booleanize}","text":"If set to TRUE, config files values of on/true/yes and off/false/no get converted to boolean values automatically. This way you can use the values in the template like so: {if #foobar#}...{/if}. If foobar was on, true or yes, the {if} statement will execute. Defaults to TRUE.
This is the directory used to store config files used in the templates. Default is ./configs, meaning that Smarty will look for the configs/ directory in the same directory as the executing php script.
Note
It is not recommended to put this directory under the web server document root.
Note
As of Smarty 3.1 the attribute \\$config_dir is no longer accessible directly. Use getConfigDir(), setConfigDir() and addConfigDir() instead.
See also getConfigDir(), setConfigDir() and addConfigDir().
If set to TRUE, the default then variables read in from config files will overwrite each other. Otherwise, the variables will be pushed onto an array. This is helpful if you want to store arrays of data in config files, just list each element multiple times.
This examples uses {cycle} to output a table with alternating red/green/blue row colors with $config_overwrite = FALSE.
The config file.
# row colors\nrowColors = #FF0000\nrowColors = #00FF00\nrowColors = #0000FF\nThe template with a {section} loop.
<table>\n {section name=r loop=$rows}\n <tr bgcolor=\"{cycle values=#rowColors#}\">\n <td> ....etc.... </td>\n </tr>\n {/section}\n</table>\nSee also {config_load}, getConfigVars(), clearConfig(), configLoad() and the config files section.
If set to TRUE, hidden sections ie section names beginning with a period(.) in config files can be read from templates. Typically you would leave this FALSE, that way you can store sensitive data in the config files such as database parameters and not worry about the template loading them. FALSE by default.
"},{"location":"programmers/api-variables/variable-debug-template/","title":"\\$debug_tpl {#variable.debug_template}","text":"This is the name of the template file used for the debugging console. By default, it is named debug.tpl and is located in src/debug.tpl.
See also $debugging and the debugging console section.
This allows alternate ways to enable debugging. NONE means no alternate methods are allowed. URL means when the keyword SMARTY_DEBUG is found in the QUERY_STRING, debugging is enabled for that invocation of the script. If $debugging is TRUE, this value is ignored.
<?php\n// shows debug console only on localhost ie\n// http://localhost/script.php?foo=bar&SMARTY_DEBUG\n$smarty->debugging = false; // the default\n$smarty->debugging_ctrl = ($_SERVER['SERVER_NAME'] == 'localhost') ? 'URL' : 'NONE';\n?>\nSee also debugging console section, $debugging and $smarty_debug_id.
This enables the debugging console. The console is a javascript popup window that informs you of the included templates, variables assigned from php and config file variables for the current script. It does not show variables assigned within a template with the {assign} function.
The console can also be enabled from the url with $debugging_ctrl.
See also {debug}, $debug_tpl, and $debugging_ctrl.
This function is called when a config file cannot be obtained from its resource.
Note
The default handler is currently only invoked for file resources. It is not triggered when the resource itself cannot be found, in which case a \\Smarty\\Exception is thrown.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->default_config_handler_func = 'my_default_config_handler_func';\n\n/**\n * Default Config Handler\n *\n * called when Smarty's file: resource is unable to load a requested file\n * \n * @param string $type resource type (e.g. \"file\", \"string\", \"eval\", \"resource\")\n * @param string $name resource name (e.g. \"foo/bar.tpl\")\n * @param string &$content config's content\n * @param integer &$modified config's modification time\n * @param Smarty $smarty Smarty instance\n * @return string|boolean path to file or boolean true if $content and $modified \n * have been filled, boolean false if no default config \n * could be loaded\n */\nfunction my_default_config_handler_func($type, $name, &$content, &$modified, Smarty $smarty) {\n if (false) {\n // return corrected filepath\n return \"/tmp/some/foobar.tpl\";\n } elseif (false) {\n // return a config directly\n $content = 'someVar = \"the config source\"';\n $modified = time();\n return true;\n } else {\n // tell smarty that we failed\n return false;\n }\n}\n\n?>\nThis tells smarty what resource type to use for config files. The default value is file, meaning that $smarty->configLoad('test.conf') and $smarty->configLoad('file:test.conf') are identical in meaning. See the resource chapter for more details.
This is an array of modifiers to implicitly apply to every variable in a template. For example, to HTML-escape every variable by default, use array('escape:\"htmlall\"'). To make a variable exempt from default modifiers, add the \\'nofilter\\' attribute to the output tag such as {$var nofilter}.
This tells smarty what resource type to use implicitly. The default value is file, meaning that $smarty->display('index.tpl') and $smarty->display('file:index.tpl') are identical in meaning. See the resource chapter for more details.
This function is called when a template cannot be obtained from its resource.
Note
The default handler is currently only invoked for file resources. It is not triggered when the resource itself cannot be found, in which case a \\Smarty\\Exception is thrown.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->default_template_handler_func = 'my_default_template_handler_func';\n\n/**\n * Default Template Handler\n *\n * called when Smarty's file: resource is unable to load a requested file\n * \n * @param string $type resource type (e.g. \"file\", \"string\", \"eval\", \"resource\")\n * @param string $name resource name (e.g. \"foo/bar.tpl\")\n * @param string &$content template's content\n * @param integer &$modified template's modification time\n * @param Smarty $smarty Smarty instance\n * @return string|boolean path to file or boolean true if $content and $modified \n * have been filled, boolean false if no default template \n * could be loaded\n */\nfunction my_default_template_handler_func($type, $name, &$content, &$modified, Smarty $smarty) {\n if (false) {\n // return corrected filepath\n return \"/tmp/some/foobar.tpl\";\n } elseif (false) {\n // return a template directly\n $content = \"the template source\";\n $modified = time();\n return true;\n } else {\n // tell smarty that we failed\n return false;\n }\n}\n\n?>\nWhen this value is set to a non-null-value it\\'s value is used as php\\'s error_reporting level inside of display() and fetch().
Smarty 3.1.2 introduced the muteExpectedErrors() function. Calling \\Smarty\\Smarty::muteExpectedErrors(); after setting up custom error handling will ensure that warnings and notices (deliberately) produced by Smarty will not be passed to other custom error handlers. If your error logs are filling up with warnings regarding filemtime() or unlink() calls, please enable Smarty\\'s error muting.
See also debugging and troubleshooting.
"},{"location":"programmers/api-variables/variable-escape-html/","title":"\\$escape_html {#variable.escape.html}","text":"Setting $escape_html to TRUE will escape all template variable output by wrapping it in htmlspecialchars({$output}, ENT_QUOTES, $char_set);, which is the same as {$variable|escape:\"html\"}.
Template designers can choose to selectively disable this feature by adding the nofilter flag: {$variable nofilter}.
Modifiers and Filters are run in the following order: modifier, default_modifier, \\$escape_html, registered variable filters, autoloaded variable filters, template instance\\'s variable filters. Everything except the individual modifier can be disabled with the nofilter flag.
Note
This is a compile time option. If you change the setting you must make sure that the templates get recompiled.
"},{"location":"programmers/api-variables/variable-force-cache/","title":"\\$force_cache {#variable.force.cache}","text":"This forces Smarty to (re)cache templates on every invocation. It does not override the $caching level, but merely pretends the template has never been cached before.
This forces Smarty to (re)compile templates on every invocation. This setting overrides $compile_check. By default this is FALSE. This is handy for development and debugging. It should never be used in a production environment. If $caching is enabled, the cache file(s) will be regenerated every time.
This is maximum time in seconds a cache lock is valid to avoid dead locks. The default value is 10 seconds.
See also $cache_locking
By setting $merge_compiled_includes to TRUE Smarty will merge the compiled template code of subtemplates into the compiled code of the main template. This increases rendering speed of templates using a many different sub-templates.
Individual sub-templates can be merged by setting the inline option flag within the {include} tag. $merge_compiled_includes does not have to be enabled for the inline merge.
::: {.informalexample}
<?php\n$smarty->merge_compiled_includes = true;\n?>\n:::
Note
This is a compile time option. If you change the setting you must make sure that the templates get recompiled.
See also {include} tag
The value of $smarty_debug_id defines the URL keyword to enable debugging at browser level. The default value is SMARTY_DEBUG.
See also debugging console section, $debugging and $debugging_ctrl.
This is the name of the default template directory. If you do not supply a resource type when including files, they will be found here. By default this is ./templates, meaning that Smarty will look for the templates/ directory in the same directory as the executing php script. \\$template_dir can also be an array of directory paths: Smarty will traverse the directories and stop on the first matching template found.
Note
It is not recommended to put this directory under the web server document root.
Note As of Smarty 3.1 the attribute \\$template_dir is no longer accessible directly. Use getTemplateDir(), setTemplateDir() and addTemplateDir() instead.
See also Template Resources, getTemplateDir(), setTemplateDir() and addTemplateDir().
Smarty will create subdirectories under the compiled templates and cache directories if $use_sub_dirs is set to TRUE, default is FALSE. In an environment where there are potentially tens of thousands of files created, this may help the filesystem speed. On the other hand, some environments do not allow PHP processes to create directories, so this must be disabled which is the default.
Sub directories are more efficient, so use them if you can. Theoretically you get much better performance on a filesystem with 10 directories each having 100 files, than with 1 directory having 1000 files. This was certainly the case with Solaris 7 (UFS)... with newer filesystems such as ext3 and especially reiserfs, the difference is almost nothing.
Note
$use_sub_dirs=true doesn\\'t work with safe_mode=On, that\\'s why it\\'s switchable and why it\\'s off by default.
$use_sub_dirs=true on Windows can cause problems.
Safe_mode is being deprecated in PHP6.
See also $compile_id, $cache_dir, and $compile_dir.
Smarty is a template engine for PHP, facilitating the separation of presentation (HTML/CSS) from application logic.
It allows you to write templates, using variables, modifiers, functions and comments, like this:
<h1>{$title|escape}</h1>\n\n<p>\n The number of pixels is: {math equation=\"x * y\" x=$height y=$width}.\n</p>\nWhen this template is rendered, with the value \"Hello world\" for the variable $title, 640 for $width, and 480 for $height, the result is:
<h1>Hello world</h1>\n\n<p>\n The number of pixels is: 307200.\n</p>\niWink, fullservice digital agency
"},{"location":"#_2","title":"Home","text":"Temma, the MVC framework based on Smarty
"},{"location":"features/","title":"Features","text":"Some of Smarty's features:
{$foo}, {{$foo}}, <!--{$foo}-->, etc.{if}..{elseif}..{else}..{/if} constructs are passed to the PHP parser, so the {if...} expression syntax can be as simple or as complex an evaluation as you like.sections, if's etc.Under the hood, Smarty \"compiles\" (basically copies and converts) the templates into PHP scripts. This happens once when each template is first invoked, and then the compiled versions are used from that point forward. Smarty takes care of this for you, so the template designer just edits the Smarty templates and never has to manage the compiled versions. This approach keeps the templates easy to maintain, and yet keeps execution times extremely fast since the compiled code is just PHP. And of course, all PHP scripts take advantage of PHP op-code caches such as APC.
"},{"location":"features/#template-inheritance","title":"Template Inheritance","text":"Template inheritance was introduced in Smarty 3. Before template inheritance, we managed our templates in pieces such as header and footer templates. This organization lends itself to many problems that require some hoop-jumping, such as managing content within the header/footer on a per-page basis. With template inheritance, instead of including other templates we maintain our templates as single pages. We can then manipulate blocks of content within by inheriting them. This makes templates intuitive, efficient and easy to manage. See Template Inheritance for more info.
"},{"location":"features/#why-not-use-xmlxslt-syntax","title":"Why not use XML/XSLT syntax?","text":"There are a couple of good reasons. First, Smarty can be used for more than just XML/HTML based templates, such as generating emails, javascript, CSV, and PDF documents. Second, XML/XSLT syntax is even more verbose and fragile than PHP code! It is perfect for computers, but horrible for humans. Smarty is about being easy to read, understand and maintain.
"},{"location":"features/#template-security","title":"Template Security","text":"Although Smarty insulates you from PHP, you still have the option to use it in certain ways if you wish. Template security forces the restriction of PHP (and select Smarty functions.) This is useful if you have third parties editing templates, and you don't want to unleash the full power of PHP or Smarty to them.
"},{"location":"features/#integration","title":"Integration","text":"Sometimes Smarty gets compared to Model-View-Controller (MVC) frameworks. Smarty is not an MVC, it is just the presentation layer, much like the View (V) part of an MVC. As a matter of fact, Smarty can easily be integrated as the view layer of an MVC. Many of the more popular ones have integration instructions for Smarty, or you may find some help here in the forums and documentation.
"},{"location":"features/#other-template-engines","title":"Other Template Engines","text":"Smarty is not the only engine following the \"Separate Programming Code from Presentation\" philosophy. For instance, Python has template engines built around the same principles such as Django Templates and CheetahTemplate. Note: Languages such as Python do not mix with HTML natively, which give them the advantage of proper programming code separation from the outset. There are libraries available to mix Python with HTML, but they are typically avoided.
"},{"location":"features/#what-smarty-is-not","title":"What Smarty is Not","text":"Smarty is not an application development framework. Smarty is not an MVC. Smarty is not an alternative to Laravel, Symfony, CodeIgniter, or any of the other application development frameworks for PHP.
Smarty is a template engine, and works as the (V)iew component of your application. Smarty can easily be coupled to any of the engines listed above as the view component. No different than any other software, Smarty has a learning curve. Smarty does not guarantee good application design or proper separation of presentation, this still needs to be addressed by a competent developer and web designer.
"},{"location":"features/#is-smarty-right-for-me","title":"Is Smarty Right for Me?","text":"Smarty is not meant to be a tool for every job. The important thing is to identify if Smarty fits your needs. There are some important questions to ask yourself:
"},{"location":"features/#template-syntax","title":"Template Syntax","text":"Are you content with PHP tags mixed with HTML? Are your web designers comfortable with PHP? Would your web designers prefer a tag-based syntax designed for presentation? Some experience working with both Smarty and PHP helps answer these questions.
"},{"location":"features/#the-business-case","title":"The Business Case","text":"Is there a requirement to insulate the templates from PHP? Do you have untrusted parties editing templates that you do not wish to unleash the power of PHP to? Do you need to programmatically control what is and is not available within the templates? Smarty supplies these capabilities by design.
"},{"location":"features/#feature-set","title":"Feature set","text":"Does Smarty's features such as caching, template inheritance and plugin architecture save development cycles writing code that would be needed otherwise? Does the codebase or framework you plan on using have the features you need for the presentation component?
"},{"location":"features/#sites-using-smarty","title":"Sites using Smarty","text":"Many well-known PHP projects make use of Smarty such as XOOPS CMS, CMS Made Simple, Tiki Wiki CMS Groupware and X-Cart to name a few.
"},{"location":"features/#summary","title":"Summary","text":"Whether you are using Smarty for a small website or massive enterprise solution, it can accommodate your needs. There are numerous features that make Smarty a great choice:
Smarty can be run with PHP 7.2 to PHP 8.4.
"},{"location":"getting-started/#installation","title":"Installation","text":"Smarty can be installed with Composer.
To get the latest stable version of Smarty use:
composer require smarty/smarty\nTo get the latest, unreleased version, use:
composer require smarty/smarty:dev-master\nTo get the previous stable version of Smarty, Smarty 4, use:
composer require smarty/smarty:^4\nHere's how you create an instance of Smarty in your PHP scripts:
<?php\n\n// Instantiated via composer\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n// or ...\n\n// Instantiated directly\nrequire(\"/path/to/smarty/libs/Smarty.class.php\");\nuse Smarty\\Smarty;\n$smarty = new Smarty();\nNow that the library files are in place, it's time to set up the Smarty directories for your application.
Smarty requires four directories which are by default named templates, configs, templates_c and cache relative to the current working directory.
The defaults can be changed as follows:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->setTemplateDir('/some/template/dir');\n$smarty->setConfigDir('/some/config/dir');\n$smarty->setCompileDir('/some/compile/dir');\n$smarty->setCacheDir('/some/cache/dir');\nThe compile dir and cache dir need to be writable for the user running the PHP script.
Note
This is usually user \"nobody\" and group \"nobody\". For OS X users, the default is user \"www\" and group \"www\". If you are using Apache, you can look in your httpd.conf file to see what user and group are being used.
chown nobody:nobody /web/www.example.com/guestbook/templates_c/\nchmod 770 /web/www.example.com/guestbook/templates_c/\n\nchown nobody:nobody /web/www.example.com/guestbook/cache/\nchmod 770 /web/www.example.com/guestbook/cache/\nYou can verify if your system has the correct access rights for these directories with testInstall():
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->setTemplateDir('/some/template/dir');\n$smarty->setConfigDir('/some/config/dir');\n$smarty->setCompileDir('/some/compile/dir');\n$smarty->setCacheDir('/some/cache/dir');\n$smarty->testInstall();\nNow, let's create the index.tpl file that Smarty will display. This needs to be located in the $template_dir.
{* Smarty *}\n<h1>Hello {$name|escape}, welcome to Smarty!</h1>\nNote
{* Smarty *} is a template comment. It is not required, but it is good practice to start all your template files with this comment. It makes the file easy to recognize regardless of the file extension. For example, text editors could recognize the file and turn on special syntax highlighting.
Now lets edit our php file. We'll create an instance of Smarty, assign() a template variable and display() the index.tpl file.
<?php\n\nrequire 'vendor/autoload.php';\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setTemplateDir('/web/www.example.com/guestbook/templates/');\n$smarty->setCompileDir('/web/www.example.com/guestbook/templates_c/');\n$smarty->setConfigDir('/web/www.example.com/guestbook/configs/');\n$smarty->setCacheDir('/web/www.example.com/guestbook/cache/');\n\n$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\nNote
In our example, we are setting absolute paths to all the Smarty directories. If /web/www.example.com/guestbook/ is within your PHP include_path, then these settings are not necessary. However, it is more efficient and (from experience) less error-prone to set them to absolute paths. This ensures that Smarty is getting files from the directories you intended.
Now, run your PHP file. You should see \"Hello Ned, welcome to Smarty!\"
You have completed the basic setup for Smarty!
"},{"location":"getting-started/#escaping","title":"Escaping","text":"You may have noticed that the example template above renders the $name variable using the escape modifier. This modifier makes string 'safe' to use in the context of an HTML page.
If you are primarily using Smarty for HTML-pages, it is recommended to enable automatic escaping. This way, you don't have to add |escape to every variable you use on a web page. Smarty will handle it automatically for you!
Enable auto-escaping for HTML as follows:
$smarty->setEscapeHtml(true);\nThis is a continuation of the basic installation, please read that first!
A slightly more flexible way to set up Smarty is to extend the Smarty class and initialize your Smarty environment. So instead of repeatedly setting directory paths, assigning the same vars, etc., we can do that in one place.
<?php\n\nuse Smarty\\Smarty;\n\nclass My_GuestBook extends Smarty {\n\n public function __construct()\n {\n parent::__construct();\n\n $this->setTemplateDir('/web/www.example.com/guestbook/templates/');\n $this->setCompileDir('/web/www.example.com/guestbook/templates_c/');\n $this->setConfigDir('/web/www.example.com/guestbook/configs/');\n $this->setCacheDir('/web/www.example.com/guestbook/cache/');\n\n $this->setEscapeHtml(true);\n\n $this->caching = Smarty::CACHING_LIFETIME_CURRENT;\n $this->assign('app_name', 'Guest Book');\n }\n\n}\nNow, we can use My_GuestBook instead of Smarty in our scripts:
<?php\n$smarty = new My_GuestBook();\n$smarty->assign('name', 'Ned');\n$smarty->display('index.tpl');\nSmarty is a template engine for PHP. More specifically, it facilitates a manageable way to separate application logic and content from its presentation. This is best described in a situation where the application programmer and the template designer play different roles, or in most cases are not the same person.
For example, let's say you are creating a web page that is displaying a newspaper article.
The article $headline, $tagline, $author and $body are content elements, they contain no information about how they will be presented. They are passed into Smarty by the application.
Then the template designer edits the templates and uses a combination of HTML tags and template tags to format the presentation of these variables with elements such as tables, div\\'s, background colors, font sizes, style sheets, svg etc.
One day the programmer needs to change the way the article content is retrieved, ie a change in application logic. This change does not affect the template designer, the content will still arrive in the template exactly the same.
Likewise, if the template designer wants to completely redesign the templates, this would require no change to the application logic.
Therefore, the programmer can make changes to the application logic without the need to restructure templates, and the template designer can make changes to templates without breaking application logic.
The Smarty design was largely driven by these goals: - clean separation of presentation from application code - PHP backend, Smarty template frontend - complement PHP, not replace it - fast development/deployment for programmers and designers - quick and easy to maintain - syntax easy to understand, no PHP knowledge necessary - flexibility for custom development - security: insulation from PHP - free, open source
"},{"location":"philosophy/#two-camps-of-thought","title":"Two camps of thought","text":"When it comes to templating in PHP, there are basically two camps of thought. The first camp exclaims that \\\"PHP is a template engine\\\". This approach simply mixes PHP code with HTML. Although this approach is fastest from a pure script-execution point of view, many would argue that the PHP syntax is messy and complicated when mixed with tagged markup such as HTML.
The second camp exclaims that presentation should be void of all programming code, and instead use simple tags to indicate where application content is revealed. This approach is common with other template engines (even in other programming languages), and is also the approach that Smarty takes. The idea is to keep the templates focused squarely on presentation, void of application code, and with as little overhead as possible.
"},{"location":"philosophy/#why-is-separating-php-from-templates-important","title":"Why is separating PHP from templates important?","text":"Two major benefits:
SYNTAX: Templates typically consist of semantic markup such as HTML. PHP syntax works well for application code, but quickly degenerates when mixed with HTML. Smarty\\'s simple {tag} syntax is designed specifically to express presentation. Smarty focuses your templates on presentation and less on \\\"code\\\". This lends to quicker template deployment and easier maintenance. Smarty syntax requires no working knowledge of PHP, and is intuitive for programmers and non-programmers alike.
INSULATION: When PHP is mixed with templates, there are no restrictions on what type of logic can be injected into a template. Smarty insulates the templates from PHP, creating a controlled separation of presentation from business logic. Smarty also has security features that can further enforce restrictions on templates.
A common question: \"Web designers have to learn a syntax anyway, why not PHP?\" Of course web designers can learn PHP, and they may already be familiar with it. The issue isn't their ability to learn PHP, it is about the consequences of mixing PHP with HTML. If designers use PHP, it is too easy to add code into templates that doesn't belong there (you just handed them a swiss-army knife when they just needed a knife.) You can teach them the rules of application design, but this is probably something they don't really need to learn (now they are developers!) The PHP manual is also an overwhelming pile of information to sift through. It is like handing the owner of a car the factory assembly manual when all they need is the owners manual. Smarty gives web designers exactly the tools they need, and gives developers fine-grained control over those tools. The simplicity of the tag-based syntax is also a huge welcome for designers, it helps them streamline the organization and management of templates.
"},{"location":"upgrading/","title":"Upgrading from an older version","text":""},{"location":"upgrading/#upgrading-from-v4-to-v5","title":"Upgrading from v4 to v5","text":"Smarty 5 adds support for PHP8.2 and drops support for PHP7.1. Smarty also adds support for new features such as the ternary operator ({$test ? $a : $b} and {$var ?: $value_if_falsy}), the null coalescing operator ({$var ?? $value_if_null}) and positional parameters for custom tags. Smarty 5 also has a brand-new extension architecture that allows you to write neat extension packs.
All Smarty code has been moved into the \\Smarty namespace. This reduces the chance of conflicts with other (your) code.
For simple use-cases, you only need to add use Smarty\\Smarty; to your script and everything will work.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('homepage.tpl');\nIf you extend Smarty or use Smarty plug-ins, please review your code to see if they assume specific class or method names. E.g.: Smarty_Internal_Template is now \\Smarty\\Template\\, SmartyException is now \\Smarty\\Exception.
Template variable scope bubbling has been simplified and made more consistent. The global scope now equals the Smarty scope in order to avoid global state side effects. Please read the documentation on language variable scope for more details.
Also, {config_load} no longer has a scope parameter, which means you can no longer load config from inside your template into the global scope (again, to avoid global state side effects). If you need to set global config, use the configLoad API method from your PHP code.
You can no longer use native PHP-functions or userland functions in your templates without registering them. If you need a function in your templates, register it first.
The easiest way to do so is as follows:
// native PHP functions used as modifiers need to be registered\n$smarty->registerPlugin('modifier', 'substr', 'substr');\n\n// userland PHP functions used as modifiers need to be registered\n$smarty->registerPlugin('modifier', 'my_special_func', 'my_special_func');\nBut you may want to consider writing a proper extension.
"},{"location":"upgrading/#passing-parameters-by-reference","title":"Passing parameters by reference","text":"You cannot use plugins that expect a parameter by reference anymore. PHP-function such as reset(), prev(), next() and end() can be registered as plugin, but they won't work because they expect a parameter by reference and Smarty will try to pass it by value.
Smarty 4 still supported some tags that have been carried over from previous version, but have never been documented.
{block_parent} should be replaced with {$smarty.block.parent}{parent} should be replaced with {$smarty.block.parent}{block_child} should be replaced with {$smarty.block.child}{child} should be replaced with {$smarty.block.child}
{make_nocache} is no longer supported
{insert} is no longer supportedIn Smarty 4, you could make many configuration changes by directly accessing public properties on the Smarty object in PHP. In many cases, these properties have been made private, and you should now use the appropriate setter method:
$smarty->left_delimiter should be replaced with $smarty->getLeftDelimiter()/$smarty->setLeftDelimiter()$smarty->right_delimiter should be replaced with $smarty->getRightDelimiter()/$smarty->setRightDelimiter()$smarty->autoload_filters should be replaced with $smarty->registerFilter()$smarty->template_dir should be replaced with $smarty->setTemplateDir()$smarty->cache_dir should be replaced with $smarty->setCacheDir()$smarty->compile_dir should be replaced with $smarty->setCompileDir()Other public properties have been removed altogether, and you should no longer access them:
$smarty->_current_file$smarty->allow_ambiguous_resources (ambiguous resources handlers should still work)$smarty->registered_filters$smarty->direct_access_security$smarty->trusted_dir$smarty->allow_php_templates$smarty->php_functions$smarty->php_modifiersWe have dropped support for $smarty->plugins_dir and $smarty->use_include_path. Use $smarty->addPluginsDir() or consider writing a proper extension.
The 'insert' plugin type is no longer supported.
The $cache_attrs parameter for registered plugins is no longer supported.
Search your code for the following changes:
$smarty->getTags() is no longer supported$smarty->appendByRef() should be replaced with $smarty->append()$smarty->assignByRef() should be replaced with $smarty->assign()$smarty->loadPlugin() should be replaced with $smarty->registerPlugin()Smarty v4 allowed setting (internal) properties for which no setter existed by using magic methods that start with either set or get. This has been removed in Smarty 5.
For example, $smarty->setErrorUnassigned(true); would set the error_unassigned property.
Every setter of getter that was ever documented or unit tested has been kept.
"},{"location":"upgrading/#removed-php-constants","title":"Removed PHP constants","text":"The following constants have been removed to prevent global side effects.
SMARTY_DIRSMARTY_SYSPLUGINS_DIRSMARTY_PLUGINS_DIRSMARTY_MBSTRINGSMARTY_HELPER_FUNCTIONS_LOADED<script> tags lo longer have deprecated type=\"text/javascript\" or language=\"Javascript\" attributes{include|dot:\"x-template-id\" file=\"included.dot.tpl\"}Smarty 4 is mostly identical to Smarty 3. Most notably, it adds support for PHP8 and drops support for PHP7.0 and below. Additionally, some deprecated features that have long been discouraged have been dropped from the language.
"},{"location":"upgrading/#muting-php8-warnings","title":"Muting PHP8 warnings","text":"If you simultaneously upgrade Smarty to v4 van PHP to v8, you may notice your error logs filling up with warnings about undefined or null template vars due to a change in how PHP handles these. This may be helpful to spot errors, but if you find this annoying, you can use $smarty->muteUndefinedOrNullWarnings() to make Smarty convert these warnings into notices.
You can no longer user ASP-style tags like <% %> and <%= %> in your templates. Replace them with {...} tags.
Check your codebase for SmartyBC. We have dropped deprecated API calls that where only accessible through the SmartyBC class.
We have completely dropped support for {php} and {include_php} tags and embedded PHP in templates. Check your templates for this, and rewrite any embedded PHP blocks, by moving logic to your PHP files or by creating a custom tag.
Search your code for the following changes:
SMARTY_RESOURCE_CHAR_SET and SMARTY_RESOURCE_DATE_FORMAT constants have been removedSmarty::muteExpectedErrors and Smarty::unmuteExpectedErrors API methods have been removedSmarty::getVariable method has been removed. Use Smarty::getTemplateVars instead.For installation instructies, please see the getting started section.
"},{"location":"api/basics/#rendering-a-template","title":"Rendering a template","text":"Here's how you create an instance of Smarty in your PHP scripts:
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\nYou now have a Smarty object that you can use to render templates.
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('string:The current smarty version is: {$smarty.version}.');\n// or \necho $smarty->fetch('string:The current smarty version is: {$smarty.version}.');\nYou probably want to manage your templates as files. Create a subdirectory called 'templates' and then configure Smarty to use that:
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setTemplateDir(__DIR__ . '/templates');\nSay you have a template file called 'version.tpl', stored in the 'templates' directory like this:
<h1>Hi</h1>\nThe current smarty version is: {$smarty.version|escape}.\nYou can now render this, using:
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setTemplateDir(__DIR__ . '/templates');\n$smarty->display('version.tpl');\nTemplates start to become really useful once you add variables to the mix.
Create a template called 'footer.tpl' in the 'templates' directory like this:
<small>Copyright {$companyName|escape}</small>\nNow assign a value to the 'companyName' variable and render your template like this:
<?php\n\nrequire 'vendor/autoload.php';\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setTemplateDir(__DIR__ . '/templates');\n$smarty->assign('companyName', 'AC & ME Corp.');\n$smarty->display('footer.tpl');\nRun this, and you will see:
<small>Copyright AC & ME Corp.</small>\nNote how the escape modifier translated the & character into the proper HTML syntax &. Read more about auto-escaping in the next section.
By default, Smarty looks for templates to render in ./templates.
You can change this, or even use multiple paths to use when looking for templates.
If you need to change this, you can use setTemplateDir() or addTemplateDir(). Use getTemplateDir() to retrieve the configured paths.
<?php\n\n // set a single directory where the config files are stored\n$smarty->setTemplateDir('./templates');\n\n// set multiple directories where templates are stored\n$smarty->setTemplateDir(['./templates', './templates_2', './templates_3']);\n\n// add directory where templates files are stored to the current list of dirs\n$smarty->addTemplateDir('./templates_1');\n\n// add multiple directories to the current list of dirs\n$smarty->addTemplateDir([\n './templates_2',\n './templates_3',\n]);\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n ->addTemplateDir('./templates_1')\n ->addTemplateDir('./templates_2');\n\n// insert a template dir before exising template dirs\n$smarty->prependTemplateDir('./more_important_templates')\n\n// get all directories where config files are stored\n$template_dirs = $smarty->getTemplateDir();\nvar_dump($template_dirs); // array\n\n// get directory identified by key\n$template_dir = $smarty->getTemplateDir(0);\nvar_dump($template_dir); // string\nSmarty compiles templates to native PHP to be as fast as possible. The default path where these PHP-files are stored is ./templates_c.
If you need to change this, you can use setCompileDir(). Use getCompileDir() to retrieve the configured path.
<?php\n\n// set another path to store compiled templates\n$smarty->setCompileDir('/data/compiled_templates');\n\n// get directory where compiled templates are stored\n$compileDir = $smarty->getCompileDir();\nSmarty can load data from config files. By default, Smarty loads the config files from ./configs.
You can change this, or even use multiple paths to use when looking for config files.
If you need to change this, you can use setConfigDir() or addConfigDir(). Use getConfigDir() to retrieve the configured paths.
<?php\n\n // set a single directory where the config files are stored\n$smarty->setConfigDir('./config');\n\n// set multiple directories where config files are stored\n$smarty->setConfigDir(['./config', './config_2', './config_3']);\n\n// add directory where config files are stored to the current list of dirs\n$smarty->addConfigDir('./config_1');\n\n// add multiple directories to the current list of dirs\n$smarty->addConfigDir([\n './config_2',\n './config_3',\n]);\n\n// chaining of method calls\n$smarty->setConfigDir('./config')\n ->addConfigDir('./config_1', 'one')\n ->addConfigDir('./config_2', 'two');\n\n// get all directories where config files are stored\n$config_dirs = $smarty->getConfigDir();\nvar_dump($config_dirs); // array\n\n// get directory identified by key\n$config_dir = $smarty->getConfigDir(0);\nvar_dump($config_dir); // string\nEven though Smarty runs templates as native PHP for maximum speed, it still needs to execute the PHP code on each call. If your data doesn't change all that often, you may be able to speed up your application even more by using output caching.
Output caching can be a tricky subject, so we devoted an entire section to caching. Be sure to read that if you want to use caching.
By default, Smarty stores caches to PHP-files in a subdirectory named ./cache.
If you need to change this, you can use setCacheDir(). Use getCacheDir() to retrieve the configured path.
<?php\n\n// set another path to store caches\n$smarty->setCacheDir('/data/caches');\n\n// get directory where cached templates are stored\n$cacheDir = $smarty->getCacheDir();\nBy default, Smarty does not escape anything you render in your templates. If you use Smarty to render a HTML-page, this means that you will have to make sure that you do not render any characters that have a special meaning in HTML, such as &, < and >, or apply the escape modifier to anything you want to render.
If you forget to do so, you may break your HTML page, or even create a vulnerability for attacks known as XSS or Cross Site Scripting.
Luckily, you can tell Smarty to automatically apply the escape modifier to any dynamic part of your template. It's like Smarty magically adds |escape to every variable you use on a web page.
Enable auto-escaping for HTML as follows:
$smarty->setEscapeHtml(true);\nWhen auto-escaping is enabled, the |escape modifier's default mode (html) has no effect, to avoid double-escaping. It is possible to force it with the force mode. Other modes (htmlall, url, urlpathinfo, quotes, javascript) may be used with the result you might expect, without double-escaping.
Even when auto-escaping is enabled, you might want to display the content of a variable without escaping it. To do so, use the |raw modifier.
Examples (with auto-escaping enabled):
{* these three statements are identical *}\n{$myVar}\n{$myVar|escape}\n{$myVar|escape:'html'}\n\n{* no double-escaping on these statements *}\n{$var|escape:'htmlall'}\n{$myVar|escape:'url'}\n{$myVar|escape:'urlpathinfo'}\n{$myVar|escape:'quotes'}\n{$myVar|escape:'javascript'}\n\n{* no escaping at all *}\n{$myVar|raw}\n\n{* force double-escaping *}\n{$myVar|escape:'force'}\nBy default, Smarty tests to see if the current template has changed since the last time it was compiled. If it has changed, it recompiles that template.
Once an application is put into production, this compile-check step is usually no longer needed and the extra checks can significantly hurt performance. Be sure to disable compile checking on production for maximum performance.
<?php\n$smarty->setCompileCheck(\\Smarty\\Smarty::COMPILECHECK_OFF);\nIf caching is enabled and compile-check is enabled, then the cache files will get regenerated if an involved template file or config file was updated.
There are a variety of encodings for textual data, ISO-8859-1 (Latin1) and UTF-8 being the most popular. Unless you change \\Smarty\\Smarty::$_CHARSET, Smarty recognizes UTF-8 as the internal charset.
Note
ISO-8859-1 has been PHP\\'s default internal charset since the beginning. Unicode has been evolving since 1991. Since then, it has become the one charset to conquer them all, as it is capable of encoding most of the known characters even across different character systems (latin, cyrillic, japanese, ...). UTF-8 is unicode\\'s most used encoding, as it allows referencing the thousands of character with the smallest size overhead possible.
Since unicode and UTF-8 are very widespread nowadays, their use is strongly encouraged.
Note
Smarty\\'s internals and core plugins are truly UTF-8 compatible since Smarty 3.1.
<?php\n\n// use japanese character encoding\nmb_internal_charset('EUC-JP');\n\n\\Smarty\\Smarty::$_CHARSET = 'EUC-JP';\n$smarty = new \\Smarty\\Smarty();\nInheritance allows you to define base templates that can be extended by child templates. Extending means that the child template can override all or some of the named block areas in the base template.
When you render the child template, the result will as if you rendered the base template, with only the block(s) that you have overridden in the child templates differing.
The inheritance tree can be as deep as you want, meaning you can extend a file that extends another one that extends another one and so on.
The child templates can not define any content besides what's inside {block} tags they override. Anything outside of {block} tags will be removed.
Template inheritance is a compile time process which creates a single compiled template file. Compared to corresponding solutions based on subtemplates included with the {include} tag it does have much better performance when rendering.
First, create a base template with one or more blocks. Then, create a child template. The child template must have an {extends} tag on its first line.
The child template can redefine one or more blocks defined in the base template.
See below for a simple example.
layout.tpl (base)
<html>\n <head>\n <title>{block name=title}Default Page Title{/block}</title>\n {block name=head}{/block}\n </head>\n <body>\n {block name=body}{/block}\n </body>\n</html>\nmyproject.tpl (child)
{extends file='layout.tpl'}\n{block name=head}\n <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n <script src=\"/js/mypage.js\"></script>\n{/block}\nmypage.tpl (grandchild)
{extends file='myproject.tpl'}\n{block name=title}My Page Title{/block}\n{block name=head}\n <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n <script src=\"/js/mypage.js\"></script>\n{/block}\n{block name=body}My HTML Page Body goes here{/block}\nTo render the above, you would use:
<?php\n$smarty->display('mypage.tpl');\nThe resulting output is:
<html>\n <head>\n <title>My Page Title</title>\n <link href=\"/css/mypage.css\" rel=\"stylesheet\" type=\"text/css\"/>\n <script src=\"/js/mypage.js\"></script>\n </head>\n <body>\n My HTML Page Body goes here\n </body>\n</html>\nNote
When compile-check is enabled, all files in the inheritance tree are checked for modifications upon each invocation. You may want to disable compile-check on production servers for this reason.
Note
If you have a subtemplate which is included with {include} and it contains {block} areas it works only if the {include} itself is called from within a surrounding {block}. In the final parent template you may need a dummy {block} for it.
The content of {block} tags from child and parent templates can be merged by the append or prepend {block} tag option flags and {$smarty.block.parent} or {$smarty.block.child} placeholders.
Instead of using {extends} tags in the template files you can define the inheritance tree in your PHP script by using the extends: resource type.
The code below will return same result as the example above.
<?php\n$smarty->display('extends:layout.tpl|myproject.tpl|mypage.tpl'); \nAs explained in basics, you can use $smarty->fetch() or $smarty->display() to render a template directly.
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('homepage.tpl');\n\n// or\n\n$output = $smarty->fetch('homepage.tpl');\nWhen you use display(), Smarty renders the template to the standard output stream. fetch() returns the output instead of echoing it.
The example above uses simple filenames to load the template. Smarty also supports loading templates from resources.
"},{"location":"api/rendering/#creating-a-template-object","title":"Creating a template object","text":"You can also create a template object which later can be prepared first, and rendered later. This can be useful, for example if you plan to re-use several templates.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// create template object with its private variable scope\n$tpl = $smarty->createTemplate('index.tpl');\n\n// assign a variable (available only to this template)\n$tpl->assign('title', 'My Homepage!');\n\n// display the template\n$tpl->display();\nMore on assigning variables in using data in templates.
"},{"location":"api/rendering/#testing-if-a-template-exists","title":"Testing if a template exists","text":"You can use templateExists() to check whether a template exists before you attempt to use it.
It accepts either a path to the template on the filesystem or a resource string specifying the template.
This example uses $_GET['page'] to {include} a content template. If the template does not exist then an error page is displayed instead. First, the page_container.tpl
<html>\n <head>\n <title>{$title|escape}</title>\n </head>\n <body>\n {* include middle content page *}\n {include file=$content_template}\n </body>\n</html>\nAnd the php script:
<?php\n\n// set the filename eg index.inc.tpl\n$mid_template = $_GET['page'].'.inc.tpl';\n\nif (!$smarty->templateExists($mid_template)){\n $mid_template = 'page_not_found.tpl';\n}\n$smarty->assign('content_template', $mid_template);\n\n$smarty->display('page_container.tpl');\nSo far in our examples, we have used simple filenames or paths when loading a template.
For example, to load a template file called homepage.tpl, from the filesystem, you could write:
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('homepage.tpl');\nThe filesystem is the default resource. Templates, however, may come from a variety of sources. When you render a template, or when you include a template from within another template, you supply a resource type, followed by : and the appropriate path and template name.
If a resource is not explicitly given, the default resource type is assumed. The resource type for the filesystem is file, which means that the previous example can be rewritten as follows:
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->display('file:homepage.tpl');\nThe file resource pulls templates source files from the directories specified using Smarty::setTemplateDir() (see Configuring Smarty).
setTemplateDir accepts a single path, but can also ben called with an array of paths. In that case, the list of directories is traversed in the order they appear in the array. The first template found is the one to process.
Smarty 3.1 introduced the bracket-syntax for specifying an element from Smarty::setTemplateDir(). This allows websites employing multiple sets of templates better control over which template to access.
The bracket-syntax can be used as follows:
<?php\n\n// setup template directories\n$smarty->setTemplateDir([\n './templates', // element: 0, index: 0\n './templates_2', // element: 1, index: 1\n '10' => 'templates_10', // element: 2, index: '10'\n 'foo' => 'templates_foo', // element: 3, index: 'foo'\n]);\n\n/*\n assume the template structure\n ./templates/foo.tpl\n ./templates_2/foo.tpl\n ./templates_2/bar.tpl\n ./templates_10/foo.tpl\n ./templates_10/bar.tpl\n ./templates_foo/foo.tpl\n*/\n\n// regular access\n$smarty->display('file:foo.tpl'); \n// will load ./templates/foo.tpl\n\n// using numeric index\n$smarty->display('file:[1]foo.tpl'); \n// will load ./templates_2/foo.tpl\n\n// using numeric string index\n$smarty->display('file:[10]foo.tpl'); \n// will load ./templates_10/foo.tpl\n\n// using string index\n$smarty->display('file:[foo]foo.tpl'); \n// will load ./templates_foo/foo.tpl\n\n// using \"unknown\" numeric index (using element number)\n$smarty->display('file:[2]foo.tpl'); \n// will load ./templates_10/foo.tpl\nAnd, from within a Smarty template:
{include file=\"file:foo.tpl\"}\n{* will load ./templates/foo.tpl *}\n\n{include file=\"file:[1]foo.tpl\"}\n{* will load ./templates_2/foo.tpl *}\n\n{include file=\"file:[foo]foo.tpl\"}\n{* will load ./templates_foo/foo.tpl *}\nTemplates outside the specified template directories require the file: template resource type, followed by the absolute path to the template (with leading slash).
<?php\n$smarty->display('file:/export/templates/index.tpl');\n$smarty->display('file:/path/to/my/templates/menu.tpl');\n````\n\nAnd from within a Smarty template:\n```smarty\n{include file='file:/usr/local/share/templates/navigation.tpl'}\nNote
With Security enabled, access to templates outside of the specified templates directories is not allowed unless you whitelist those directories.
If you are running on Windows, file paths usually include a drive letter (such as C:) at the beginning of the pathname. Be sure to use file: in the path to avoid namespace conflicts and get the desired results.
<?php\n$smarty->display('file:C:/export/templates/index.tpl');\n$smarty->display('file:F:/path/to/my/templates/menu.tpl');\nAnd from within Smarty template:
{include file='file:D:/usr/local/share/templates/navigation.tpl'}\nIf the file resource cannot find the requested template, it will check if there is a default template handler to call. By default, there is none, and Smarty will return an error, but you can register a default template handler calling Smarty::registerDefaultTemplateHandler with any callable.
<?php\n\n$smarty->registerDefaultTemplateHandler([$this, 'handleMissingTemplate']);\n\n// ...\n\npublic function handleMissingTemplate($type, $name, &$content, &$modified, Smarty $smarty) {\n if (/* ... */) {\n // return corrected filepath\n return \"/tmp/some/foobar.tpl\";\n } elseif (/* ... */) {\n // return a template directly\n $content = \"the template source\";\n $modified = time();\n return true;\n } else {\n // tell smarty that we failed\n return false;\n }\n}\nSmarty can render templates from a string by using the string: or eval: resource.
The string: resource behaves much the same as a template file. The template source is compiled from a string and stores the compiled template code for later reuse. Each unique template string will create a new compiled template file. If your template strings are accessed frequently, this is a good choice. If you have frequently changing template strings (or strings with low reuse value), the eval: resource may be a better choice, as it doesn\\'t save compiled templates to disk.
The eval: resource evaluates the template source every time a page is rendered. This is a good choice for strings with low reuse value. If the same string is accessed frequently, the string: resource may be a better choice.
Note
With a string: resource type, each unique string generates a compiled file. Smarty cannot detect a string that has changed, and therefore will generate a new compiled file for each unique string. It is important to choose the correct resource so that you do not fill your disk space with wasted compiled strings.
<?php\n$smarty->assign('foo', 'value');\n$template_string = 'display {$foo} here';\n$smarty->display('string:' . $template_string); // compiles for later reuse\n$smarty->display('eval:' . $template_string); // compiles every time\n{include file=\"string:$template_string\"} {* compiles for later reuse *}\n{include file=\"eval:$template_string\"} {* compiles every time *}\nBoth string: and eval: resources may be encoded with urlencode() or base64_encode(). This is not necessary for the usual use of string: and eval:, but is required when using either of them in conjunction with the extends resource.
<?php\n $smarty->assign('foo','value');\n $template_string_urlencode = urlencode('display {$foo} here');\n $template_string_base64 = base64_encode('display {$foo} here');\n $smarty->display('eval:urlencode:' . $template_string_urlencode); // will decode string using urldecode()\n $smarty->display('eval:base64:' . $template_string_base64); // will decode string using base64_decode()\nFrom within a Smarty template:
{include file=\"string:urlencode:$template_string_urlencode\"} {* will decode string using urldecode() *}\n {include file=\"eval:base64:$template_string_base64\"} {* will decode string using base64_decode() *}\nThe extends: resource is used to define child/parent relationships. For details see section of Template inheritance.
Note
Using the extends resource is usually not necessary. If you have a choice, it is normally more flexible and intuitive to handle inheritance chains from within the templates using the {extends} tag.
When string: and eval: templates are used, make sure they are properly url or base64 encoded.
The templates within an inheritance chain are not compiled separately. Only a single compiled template will be generated. (If an eval: resource is found within an inheritance chain, its \"don't save a compile file\" property is superseded by the extends: resource.)
Example:
<?php\n$smarty->display('extends:parent.tpl|child.tpl|grandchild.tpl'); \n\n// inheritance from multiple template sources\n$smarty->display('extends:db:parent.tpl|file:child.tpl|grandchild.tpl|eval:{block name=\"fooBazVar_\"}hello world{/block}'); \nSmarty allow you to use PHP streams as a template resource. Smarty will first look for a registered template resource. If nothing is found, it will check if a PHP stream is available. If a stream is available, Smarty will use it to fetch the template.
For example,
<?php\nstream_wrapper_register('myresource', MyResourceStream::class);\n$smarty->display('myresource:bar.tpl');\nOr, from within a template:
{include file=\"myresource:bar.tpl\"}\nYou can create a class that extends Smarty\\Resource\\CustomPlugin to add your own resource type, for example to load template from a database.
For example:
<?php\nclass HelloWorldResource extends Smarty\\Resource\\CustomPlugin {\n\n protected function fetch($name, &$source, &$mtime) {\n $source = '{$x=\"hello world\"}{$x}'; // load your template here based on $name\n $mtime = time();\n }\n\n}\n\n// ..\n\n$smarty->registerResource('helloworld', new HelloWorldResource());\nIf a Resource's templates should not be run through the Smarty compiler, the Custom Resource may extend \\Smarty\\Resource\\UncompiledPlugin. The Resource Handler must then implement the function renderUncompiled(\\Smarty\\Template $_template). $_template is a reference to the current template and contains all assigned variables which the implementor can access via $_template->getSmarty()->getTemplateVars(). These Resources simply echo their rendered content to the output stream. The rendered output will be output-cached if the Smarty instance was configured accordingly. See src/Resource/PhpPlugin.php for an example.
If the Resource's compiled templates should not be cached on disk, the Custom Resource may extend \\Smarty\\Resource\\RecompiledPlugin. These Resources are compiled every time they are accessed. This may be an expensive overhead. See src/Resource/StringEval.php for an example.
The default resource type is file. If you want to change it, use Smarty::setDefaultResourceType.
The following example will change the default resource type to mysql:
<?php\n$smarty->setDefaultResourceType('mysql');\nSecurity is good for situations when you have untrusted parties editing the templates, and you want to reduce the risk of system security compromises through the template language.
The settings of the security policy are defined by overriding public properties of an instance of the \\Smarty\\Security class. These are the possible settings:
$secure_dir is an array of template directories that are considered secure. A directory configured using $smarty->setTemplateDir() is considered secure implicitly. The default is an empty array.$trusted_uri is an array of regular expressions matching URIs that are considered trusted. This security directive is used by {fetch} and {html_image}. URIs passed to these functions are reduced to {$PROTOCOL}://{$HOSTNAME} to allow simple regular expressions (without having to deal with edge cases like authentication-tokens).The expression '#https?://.*smarty.net$#i' would allow accessing the following URIs:
- `http://smarty.net/foo`\n- `http://smarty.net/foo`\n- `http://www.smarty.net/foo`\n- `http://smarty.net/foo`\n- `https://foo.bar.www.smarty.net/foo/bla?blubb=1`\nbut deny access to these URIs:
- `http://smarty.com/foo` (not matching top-level domain \\\"com\\\")\n- `ftp://www.smarty.net/foo` (not matching protocol \\\"ftp\\\")\n- `http://www.smarty.net.otherdomain.com/foo` (not matching end of\n domain \\\"smarty.net\\\")\n$static_classes is an array of classes that are considered trusted. The default is an empty array which allows access to all static classes. To disable access to all static classes set $static_classes = null.
$streams is an array of streams that are considered trusted and can be used from within template. To disable access to all streams set $streams = null. An empty array ( $streams = [] ) will allow all streams. The default is array('file').
$allowed_modifiers is an array of (registered / autoloaded) modifiers that should be accessible to the template. If this array is non-empty, only the herein listed modifiers may be used. This is a whitelist.
$disabled_modifiers is an array of (registered / autoloaded) modifiers that may not be accessible to the template.
$allowed_tags is a boolean flag which controls if constants can function-, block and filter plugins that should be accessible to the template. If this array is non-empty, only the herein listed modifiers may be used. This is a whitelist.
$disabled_tags is an array of (registered / autoloaded) function-, block and filter plugins that may not be accessible to the template.
$allow_constants is a boolean flag which controls if constants can be accessed by the template. The default is \"true\".
$allow_super_globals is a boolean flag which controls if the PHP super globals can be accessed by the template. The default is \"true\".
If security is enabled, no private methods, functions or properties of static classes or assigned objects can be accessed (beginning with '_') by the template.
To customize the security policy settings you can extend the \\Smarty\\Security class or create an instance of it.
<?php\n\nuse Smarty\\Smarty;\n\nclass My_Security_Policy extends \\Smarty\\Security {\n public $allow_constants = false;\n}\n\n$smarty = new Smarty();\n\n$smarty->enableSecurity('My_Security_Policy');\n<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n\n$my_security_policy = new \\Smarty\\Security($smarty);\n$my_security_policy->allow_constants = false;\n\n$smarty->enableSecurity($my_security_policy);\n<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n\n// enable default security\n$smarty->enableSecurity();\nNote
Most security policy settings are only checked when the template gets compiled. For that reason you should delete all cached and compiled template files when you change your security settings.
"},{"location":"api/caching/basics/","title":"Caching","text":"Caching is used to speed up the rendering of a template by saving and re-using the output.
If a cached version of the call is available, that is displayed instead of regenerating the output. Caching can speed things up tremendously, especially templates with longer computation times.
Since templates can include or extend other templates, one cache file could conceivably be made up of several template files, config files, etc.
** Note **
Since templates are dynamic, it is important to be careful what you are caching and for how long. For instance, if you are displaying the front page of your website that does not change its content very often, it might work well to cache this page for an hour or more. On the other hand, if you are displaying a page with a timetable containing new information by the minute, it would not make sense to cache this page.
"},{"location":"api/caching/basics/#setting-up-caching","title":"Setting Up Caching","text":"The first thing to do is enable caching by calling Smarty::setCaching() with either \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT or \\Smarty\\Smarty::CACHING_LIFETIME_SAVED. Or with \\Smarty\\Smarty::CACHING_OFF to disable caching again.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// enable caching, using the current lifetime (see below)\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// enable caching, using the lifetime set when the cache was saved (see below)\n$smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);\n\n// disable caching\n$smarty->setCaching(Smarty::CACHING_OFF);\n\n$smarty->display('index.tpl');\nWith caching enabled, the function call to $smarty->display('index.tpl') will render the template as usual, but also saves a copy of its output. On the next call to $smarty->display('index.tpl'), the cached copy will be used instead of rendering the template again.
Note
By default, Smarty saved its caches as files in a dir called cache relative to the current directory. The default directory can be changed using $smarty->setCacheDir('/some/cache/dir'); The files are named similar to the template name. Although they end in the .php extension, they are not intended to be directly executable. Do not edit these files!
Each cached page has a limited lifetime. The default value is 3600 seconds, or one hour. After that time expires, the cache is regenerated.
You can change the lifetime as follows:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT); \n// or $smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);\n\n// set the cache_lifetime to 5 minutes\n$smarty->setCacheLifetime(5 * 60);\nSetting caching to a value of \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT tells Smarty to use the current lifetime to determine if the cache has expired.
A value of \\Smarty\\Smarty::CACHING\\_LIFETIME\\_SAVED tells Smarty to use the lifetime value at the time the cache was generated. This way you can set the just before rendering a template to have granular control over when that particular cache expires.
An example:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// retain current cache lifetime for each specific display call\n$smarty->setCaching(Smarty::CACHING_LIFETIME_SAVED);\n\n// set the cache_lifetime for index.tpl to 5 minutes\n$smarty->setCacheLifetime(300);\n$smarty->display('index.tpl');\n\n// set the cache_lifetime for home.tpl to 1 hour\n$smarty->setCacheLifetime(3600);\n$smarty->display('home.tpl');\n\n// NOTE: the following $cache_lifetime setting will not work when $caching\n// is set to Smarty::CACHING_LIFETIME_SAVED.\n// The cache lifetime for home.tpl has already been set\n// to 1 hour, and will no longer respect the value of $cache_lifetime.\n// The home.tpl cache will still expire after 1 hour.\n$smarty->setCacheLifetime(30); // 30 seconds\n$smarty->display('home.tpl');\nBy default, every template file and config file that is involved with the cache file is checked for modification. If any of the files have been modified since the cache was generated, the cache is immediately regenerated.
This is a computational overhead, so for optimum performance, disable this on a production environment:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n$smarty->setCompileCheck(Smarty::COMPILECHECK_OFF);\n\n$smarty->display('index.tpl');\nSmarty's `isCached() method can be used to test if a template has a valid cache or not. If you have a cached template that requires something like a database fetch, you can use this to skip that process.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif (!$smarty->isCached('index.tpl')) {\n // No cache available, do variable assignments here.\n $smarty->assign('data', do_expensive_database_calls());\n}\n\n$smarty->display('index.tpl');\nYou can keep parts of a page dynamic (disable caching) with the {nocache}{/nocache} block function, or by using the nocache parameter for most template functions.
Let's say the whole page can be cached except for a banner that is displayed down the side of the page. By using a {nocache}{/nocache} block for the banner, you can keep this element dynamic within the cached content.
You can clear all the cache files with Smarty's clearAllCache() method, or individual cache files with the clearCache() method.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear only cache for index.tpl\n$smarty->clearCache('index.tpl');\n\n// clear out all cache files\n$smarty->clearAllCache();\n\n// clear out all cache files older than one hour\n$smarty->clearAllCache(3600);\n\n// or, clear all expired caches\n$smarty->clearAllCache(Smarty::CLEAR_EXPIRED);\nAs an alternative to using the default file-based caching mechanism, you can specify a custom cache implementation that will be used to read, write and clear cached files.
With a custom cache implementation you could replace the slow filesystem by a faster storage engine, centralize the cache to be accessible to multiple servers.
Smarty requires implementations to extend \\Smarty\\Cacheresource\\Base, but encourages you to either extend \\Smarty\\Cacheresource\\Custom or \\Smarty\\Cacheresource\\KeyValueStore.
\\Smarty\\Cacheresource\\Custom is a simple API directing all read, write, clear calls to your implementation. This API allows you to store wherever and however you deem fit. \\Smarty\\Cacheresource\\KeyValueStore allows you to turn any KeyValue-Store (like APC or Memcache) into a full-featured CacheResource implementation. Everything around deep cache-groups like \"a|b|c\" is being handled for you in a way that guarantees clearing the cache-group \"a\" will clear all nested groups as well - even though KeyValue-Stores don't allow this kind of hierarchy by nature.Custom CacheResources must be registered on runtime with Smarty\\Smarty::setCacheResource():
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->setCacheResource(new My_CacheResource_Mysql());\nYou can have multiple cache files for a single call to display() or fetch().
Let's say that a call to $smarty->display('index.tpl') may have several different output contents depending on some condition, and you want separate caches for each one. You can do this by passing a $cache_id as the second parameter to the function call:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$my_cache_id = (int) $_GET['article_id'];\n\n$smarty->display('index.tpl', $my_cache_id);\nAbove, we are passing the variable $my_cache_id to display() as the $cache_id. For each unique value of $my_cache_id, a separate cache will be generated for index.tpl. In this example, article_id was passed in the URL and is used as the $cache_id.
Note
Be very cautious when passing values from a client (web browser) into Smarty or any PHP application. Although the above example of using the article_id from the URL looks handy, it could have bad consequences. The $cache_id is used to create a directory on the file system, so if the user decided to write a script that sends random article_id's at a rapid pace, this could possibly cause problems at the server level. Be sure to sanitize any data passed in before using it. In this example, you might want to check if the article_id is a valid ID in the database.
Be sure to pass the same $cache_id as the second parameter to isCached() and clearCache().
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n$my_cache_id = (int) $_GET['article_id'];\n\nif (!$smarty->isCached('index.tpl', $my_cache_id)) {\n // ...\n}\n\n$smarty->display('index.tpl', $my_cache_id);\nYou can clear all caches for a particular $cache_id by passing NULL as the first parameter to clearCache().
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear all caches with \"sports\" as the $cache_id\n$smarty->clearCache(null, 'sports');\n\n$smarty->display('index.tpl', 'sports');\nIn this manner, you can \"group\" your caches together by giving them the same $cache_id.
You can do more elaborate grouping by setting up $cache_id groups. This is accomplished by separating each sub-group with a vertical bar | in the $cache_id value. You can have as many sub-groups as you like.
You can think of cache groups like a directory hierarchy. For instance, a cache group of 'a|b|c' could be thought of as the directory structure '/a/b/c/'.
clearCache(null, 'a|b|c') would be like removing the files '/a/b/c/*'. clearCache(null, 'a|b') would be like removing the files '/a/b/*'.
If you specify a template name such as clearCache('foo.tpl', 'a|b|c') then Smarty will attempt to remove '/a/b/c/foo.tpl'.
You CANNOT remove a specified template name under multiple cache groups such as '/a/b/*/foo.tpl', the cache grouping works left-to-right ONLY. You will need to group your templates under a single cache group hierarchy to be able to clear them as a group.
Cache grouping should not be confused with your template directory hierarchy, the cache grouping has no knowledge of how your templates are structured. So for example, if you have a template structure like themes/blue/index.tpl and you want to be able to clear all the cache files for the \"blue\" theme, you will need to create a cache group structure that mimics your template file structure, such as display('themes/blue/index.tpl', 'themes|blue'), then clear them with clearCache(null, 'themes|blue').
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\n// clear all caches with 'sports|basketball' as the first two cache_id groups\n$smarty->clearCache(null, 'sports|basketball');\n\n// clear all caches with \"sports\" as the first cache_id group. This would\n// include \"sports|basketball\", or \"sports|(anything)|(anything)|(anything)|...\"\n$smarty->clearCache(null, 'sports');\n\n// clear the foo.tpl cache file with \"sports|basketball\" as the cache_id\n$smarty->clearCache('foo.tpl', 'sports|basketball');\n\n$smarty->display('index.tpl', 'sports|basketball');\nBlock tags are tags of the form: {func} .. {/func}. In other words, they enclose a template block and operate on the contents of this block.
Block functions take precedence over normal tags of the same name, that is, you cannot have both custom tag {func} and block tag {func}..{/func}.
By default, your function implementation is called twice by Smarty: once for the opening tag, and once for the closing tag. (See $repeat below on how to change this.)
Only the opening tag of the block has attributes. All attributes are contained in the $params variable as an associative array. The opening tag attributes are also accessible to your function when processing the closing tag.
The value of the $content variable depends on whether your function is called for the opening or closing tag. In case of the opening tag, it will be NULL, and in case of the closing tag it will be the contents of the template block. Note that the template block will have already been processed by Smarty, so all you will receive is the template output, not the template source.
The parameter $repeat is passed by reference to the function implementation and provides a possibility for it to control how many times the block is displayed. By default $repeat is TRUE at the first call of the block function (the opening tag) and FALSE on all subsequent calls to the block function (the block's closing tag). Each time the function implementation returns with $repeat being TRUE, the contents between {func}...{/func} are evaluated and the function implementation is called again with the new block contents in the parameter $content.
Example:
<?php\n\nfunction smarty_block_translate($params, $content, \\Smarty\\Template $template, &$repeat) {\n // only output on the closing tag\n if (!$repeat){\n if (isset($content)) {\n $lang = $params['lang'];\n // do some intelligent translation thing here with $content\n return $translation;\n }\n }\n}\n\n$smarty->registerPlugin(Smarty\\Smarty::PLUGIN_BLOCK, 'translate', 'smarty_block_translate');\nThis can now be used in your templates as follows:
{translate lang='nl'}\n Quia omnis nulla omnis iusto est id et.\n{/translate}\nIn order to organize your custom tags and modifiers, you can create an Extension. In fact, most of Smarty itself is organized into two extensions:
{if}, {for} and {assign}. |escape, |nl2br and |number_format and tags such as {html_image}, {mailto} and {textformat} that are enabled by default, but not necessarily universal.** Note **
There is also the 'BCPluginsAdapter' extension, which does not add any new functionality, but wraps calls to deprecated methods such as Smarty\\Smarty::addPluginsDir() and Smarty\\Smarty::loadFilter().
In order to write your own custom extension, you must write a class that implements Smarty\\Extension\\ExtensionInterface. However, it is usually easier to extend Smarty\\Extension\\Base which provides empty implementation for each of the methods required by Smarty\\Extension\\ExtensionInterface. This allows you to only override the method(s) you need.
Example:
<?php\n\nuse Smarty\\Extension\\Base;\n\nclass MyExtension extends Base {\n\n public function getModifierCompiler(string $modifier): ?\\Smarty\\Compile\\Modifier\\ModifierCompilerInterface {\n\n switch ($modifier) {\n case 'array_escape': return new MyArrayEscapeModifierCompiler();\n case 'array_unescape': return new MyArrayUnescapeModifierCompiler();\n }\n\n return null;\n }\n}\n<?php\n\nuse Smarty\\Extension\\Base;\n\nclass MyCallablePassThroughExtension extends Base {\n\n public function getModifierCallback(string $modifierName) {\n\n if (is_callable($modifierName)) {\n return $modifierName;\n }\n\n return null;\n }\n}\nWriting an extension allows you to add a group of tags, block tags and modifiers to the Smarty language. It also allows you to register pre-, post- and output-filters in a structured way. The files in src/Extension/ in the smarty/smarty dir should give you all the information you need to start writing your own extension.
When you have written your extension, add it to a Smarty instance as follows:
<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n\n$smarty->addExtension(new MyCustomExtension());\nThis will add MyCustomExtension to the end of the extension list, meaning that you cannot override tags or modifiers from one of Smarty's default extensions.
Should you wish to insert your extension at the top of the extension list, or create a very limited Smarty version that only contains the core extension, you can use Smarty\\Smarty::setExtensions() to override the list of extensions.
<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n\n$smarty->setExtensions([\n new Smarty\\Extension\\CoreExtension(),\n new MyCustomExtension(),\n new Smarty\\Extension\\DefaultExtension(),\n]);\nBy default, Smarty is already very complete and powerful. However, you can unlock its real potential by extending Smarty.
There are various ways to extend Smarty for it to suit your needs. You can create custom tags, block tags and modifiers by registering a method as a plugin.
If this becomes too messy, you can group your custom tags, modifiers, and more into an Extension.
"},{"location":"api/extending/modifiers/","title":"Custom modifiers","text":"Modifiers are little functions that are applied to a variable in the template before it is displayed or used in some other context. Smarty comes with a bunch of modifiers, but you can easily add your own.
In order to do so, you must write a function that accepts as its first parameter the value on which the modifier is to operate. The rest of the parameters are optional, depending on what kind of operation is to be performed.
The modifier has to return the result of its processing.
For example:
<?php\n\nfunction smarty_modifier_substr($string, $offset, $length) {\n return substr($string, $offset, $length);\n}\n\n$smarty->registerPlugin(Smarty\\Smarty::PLUGIN_MODIFIER, 'substr', 'smarty_modifier_substr');\nYou can now use this in your templates as follows:
{$applicationName|substr:0:20}\nYou can add your own tags to the Smarty language.
"},{"location":"api/extending/tags/#runtime-tags","title":"Runtime tags","text":"Usually, you'll add a runtime tag. Adding a runtime tag requires you to provide a callback function that accepts two parameters:
$params: all attributes from the template as an associative array.$template: a Smarty\\Template object representing the template where tag was used.The output (return value) of the function will be substituted in place of the tag in the template.
If the function needs to assign some variables to the template or use some other Smarty-provided functionality, it can use the supplied $template object to do so.
<?php\n\nfunction smarty_tag_eightball($params, \\Smarty\\Template $template): string {\n $answers = [\n 'Yes',\n 'No',\n 'No way',\n 'Outlook not so good',\n 'Ask again soon',\n 'Maybe in your reality'\n ];\n\n $result = array_rand($answers);\n return $answers[$result];\n}\n\n$smarty->registerPlugin(Smarty\\Smarty::PLUGIN_FUNCTION, 'eightball', 'smarty_tag_eightball');\nWhich can now be used in the template as:
Question: Will we ever have time travel?\nAnswer: {eightball}.\nCompiler tags are called only during compilation of the template.
They are useful for injecting PHP code or time-sensitive static content into the template. If there is both a compiler function and a runtime tag registered under the same name, the compiler function has precedence.
The compiler function is passed two parameters: the params array which contains precompiled strings for the attribute values and the Smarty object. It's supposed to return the code to be injected into the compiled template including the surrounding PHP tags.
Example:
<?php\n\nfunction smarty_compiler_tplheader($params, Smarty $smarty) {\n return \"<?php\\necho '\" . $smarty->_current_file . \" compiled at \" . date('Y-m-d H:M'). \"';\\n?>\";\n}\n\n$smarty->registerPlugin(Smarty\\Smarty::PLUGIN_COMPILER, 'tplheader', 'smarty_compiler_tplheader');\nThis function can be called from the template as:
{* this function gets executed at compile time only *}\n{tplheader}\nThe resulting PHP code in the compiled template would be something like this:
<?php\necho 'index.tpl compiled at 2023-02-20 20:02';\nWhen a template is rendered, its output can be sent through one or more output filters.
Note This differs from prefilters and postfilters because, pre- and postfilters operate on compiled templates before they are saved to the disk, whereas output filters operate on the template output when it is executed.
Smarty will pass the template output as the first argument, and expect the function to return the result of the processing.
Output filters can be either added as part of an Extension or registered as shown below.
This will provide a rudimentary protection against spambots:
<?php\n\nfunction protect_email($tpl_output, \\Smarty\\Template\\ $template)\n{\n return preg_replace(\n '!(\\S+)@([a-zA-Z0-9\\.\\-]+\\.([a-zA-Z]{2,3}|[0-9]{1,3}))!',\n '$1%40$2', \n $tpl_output\n );\n}\n\n// register the outputfilter\n$smarty->registerFilter(\"output\", \"protect_email\");\n$smarty->display(\"index.tpl');\nTemplate postfilters are PHP functions that your templates are ran through after they are compiled.
Smarty will pass the compiled template code as the first argument, and expect the function to return the result of the processing, which must also be valid PHP code.
Prefilters can be either added as part of an Extension or registered as shown below.
<?php\n\nfunction add_header_comment($tpl_source, \\Smarty\\Template\\ $template)\n{\n return \"<?php echo \\\"<!-- Created by Smarty! -->\\n\\\"; ?>\\n\".$tpl_source;\n}\n\n// register the postfilter\n$smarty->registerFilter('post', 'add_header_comment');\n$smarty->display('index.tpl');\nThe postfilter above will make the compiled Smarty template index.tpl look like:
<!-- Created by Smarty! -->\n{* rest of template content... *}\nTemplate prefilters are PHP functions that your templates are ran through before they are compiled. This is good for preprocessing your templates to remove unwanted comments, keeping an eye on what people are putting in their templates, etc.
Smarty will pass the template source code as the first argument, and expect the function to return the resulting template source code.
Prefilters can be either added as part of an Extension or registered as shown below.
This will remove all the html comments in the template source:
<?php\n\nfunction remove_dw_comments($tpl_source, \\Smarty\\Template\\ $template)\n{\n return preg_replace(\"/<!--#.*-->/U\",'',$tpl_source);\n}\n\n// register the prefilter\n$smarty->registerFilter('pre', 'remove_dw_comments');\n$smarty->display('index.tpl');\nTemplates start to become really useful once you know how to use variables.
"},{"location":"api/variables/assigning/#basic-assigning","title":"Basic assigning","text":"Let's revisit the example from the basics section. The following script assigns a value to the 'companyName' variable and renders the template:
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->assign('companyName', 'AC & ME Corp.');\n\n$smarty->display('footer.tpl');\nfooter.tpl:
<small>Copyright {$companyName|escape}</small>\nSmarty will apply the escape modifier to the value assigned to the variable companyName and replace {$companyName|escape} with the result.
<small>Copyright AC & ME Corp.</small>\nUsing $smarty->assign() is the most common way of assigning data to templates, but there are several other methods.
Using append(), you can add data to an existing variable, usually an array.
If you append to a string value, it is converted to an array value and then appended to. You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs. If you pass the optional third parameter of TRUE, the value will be merged with the current array instead of appended.
Examples:
<?php\n// This is effectively the same as assign()\n$smarty->append('foo', 'Fred');\n// After this line, foo will now be seen as an array in the template\n$smarty->append('foo', 'Albert');\n\n$array = [1 => 'one', 2 => 'two'];\n$smarty->append('X', $array);\n$array2 = [3 => 'three', 4 => 'four'];\n// The following line will add a second element to the X array\n$smarty->append('X', $array2);\n\n// passing an associative array\n$smarty->append(['city' => 'Lincoln', 'state' => 'Nebraska']);\nWhen you use a template objects, as explained in rendering a template, you can assign data to the template objects directly instead of assigning it to Smarty. This way, you can use different sets of data for different templates.
For example:
<?php\n\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$tplBlue = $smarty->createTemplate('blue.tpl');\n$tplBlue->assign('name', 'The one');\n$tplBlue->display();\n\n$tplRed = $smarty->createTemplate('red.tpl');\n$tplRed->assign('name', 'Neo');\n$tplRed->display();\nFor more complex use cases, Smarty supports the concept of data objects. Data objects are containers to hold data. Data objects can be attached to templates when creating them. This allows for fine-grained re-use of data.
For example:
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// create a data object\n$data = $smarty->createData();\n\n// assign variable to the data object\n$data->assign('name', 'Neo');\n\n// create template object which will use variables from the data object\n$tpl = $smarty->createTemplate('index.tpl', $data);\n\n// display the template\n$tpl->display();\nWhen re-using templates, you may need to clear data assigned in a previous run. Use clearAllAssign() to clear the values of all assigned variables on data objects, template objects or the Smarty object.
Examples:
<?php\n// assigning data to the Smarty object\n$smarty->assign('Name', 'Fred');\n// ...\n$smarty->clearAllAssign();\n\n// using a data object\n$data = $smarty->createData();\n$data->assign('name', 'Neo');\n// ...\n$data->clearAllAssign();\n\n// using a template\n$tplBlue = $smarty->createTemplate('blue.tpl');\n$tplBlue->assign('name', 'The one');\n// ...\n$tplBlue->clearAllAssign();\nNote that there it's only useful to clear assigned data if you:
If your script simply runs once and then ends, or you always assign the same variables, clearing assigned data is of no use.
"},{"location":"api/variables/config-files/","title":"Loading data from config files","text":"Instead of assigning data to templates from PHP, you can also use a config file.
"},{"location":"api/variables/config-files/#example-config-file","title":"Example config file","text":"Config files are best suited to manage template settings from one file. One example is a multi-language application. Instead of writing multiple templates to support different languages, you can write a single template file and load your language dependent strings from config files.
Example lang.en.ini:
# global variables\npageTitle = \"Main Menu\"\n\n[Customer]\npageTitle = \"Customer Info\"\n\n[Login]\npageTitle = \"Login\"\nfocus = \"username\"\nIntro = \"\"\"This is a value that spans more\n than one line. you must enclose\n it in triple quotes.\"\"\"\nValues of config file variables can be in quotes, but not necessary. You can use either single or double quotes. If you have a value that spans more than one line, enclose the entire value with triple quotes (\"\"\"). You can put comments into config files by any syntax that is not a valid config file syntax. We recommend using a # (hash) at the beginning of the line.
The example config file above has two sections. Section names are enclosed in [brackets]. Section names can be arbitrary strings not containing [ or ] symbols. The variable at the top is a global variable. Global variables are always loaded from the config file. If a particular section is loaded, then the global variables and the variables from that section are also loaded. If a variable exists both as a global and in a section, the section variable is used.
Config files are loaded into templates with the built-in template function {config_load} or by calling configLoad() from PHP:
<?php\n$smarty->configLoad('lang.en.ini');\nLoad a specific section with:
<?php\n$smarty->configLoad('lang.en.ini', 'Customer');\nNote that the global section will always be loaded.
"},{"location":"api/variables/config-files/#retrieving-config-variables-in-php","title":"Retrieving config variables in PHP","text":""},{"location":"api/variables/config-files/#loading-from-a-resource","title":"Loading from a resource","text":"Config files (or resources) are loaded by the same resource facilities as templates. That means that a config file can also be loaded from a db. See resources for more information.
"},{"location":"api/variables/config-files/#config-overwrite","title":"Config overwrite","text":"If you name two variables the same within a section, the last one will be used unless you call:
<?php\n$smarty->setConfigOverwrite(false);\nSee also {config_load}, $default_config_handler_func, getConfigVars(), clearConfig() and configLoad()
Smarty allows access to PHP objects through the templates.
Note
When you assign/register objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.
There are two ways to access them.
"},{"location":"api/variables/objects/#assign-the-object","title":"Assign the object","text":"You can assign objects to a template and access them much like any other assigned variable.
Example:
<?php\n// the object\n\nclass My_Object {\n public function meth1($params, $smarty_obj) {\n return 'this is my meth1';\n }\n}\n\n// We can also assign objects. assign_by_ref when possible.\n$smarty->assign('myobj', new My_Object());\n\n$smarty->display('index.tpl');\nAnd here's how to access your object in index.tpl:
{$myobj->meth1('foo',$bar)}\nRegisterd objects use a different template syntax. Also, a registered object can be restricted to certain methods or properties. However, a registered object cannot be looped over or assigned in arrays of objects, etc.
If security is enabled, no private methods or functions can be accessed (beginning with '_'). If a method and property of the same name exist, the method will be used.
You can restrict the methods and properties that can be accessed by listing them in an array as the third registration parameter.
By default, parameters passed to objects through the templates are passed the same way custom tags get them. An associative array is passed as the first parameter, and the smarty object as the second. If you want the parameters passed one at a time for each argument like traditional object parameter passing, set the fourth registration parameter to FALSE.
The optional fifth parameter has only effect with format being TRUE and contains a list of methods that should be treated as blocks. That means these methods have a closing tag in the template ({foobar->meth2}...{/foobar->meth2}) and the parameters to the methods have the same synopsis as the parameters for block tags: They get the four parameters $params, $content, $smarty and &$repeat and they also behave like block tags.
<?php\n// the object\n\nclass My_Object {\n function meth1($params, $smarty_obj) {\n return 'this is my meth1';\n }\n}\n\n$myobj = new My_Object;\n\n// registering the object\n$smarty->registerObject('foobar', $myobj);\n\n// if we want to restrict access to certain methods or properties, list them\n$smarty->registerObject('foobar', $myobj, array('meth1','meth2','prop1'));\n\n// if you want to use the traditional object parameter format, pass a boolean of false\n$smarty->registerObject('foobar', $myobj, null, false);\n\n$smarty->display('index.tpl');\nAnd here's how to access your objects in index.tpl:
{* access our registered object *}\n{foobar->meth1 p1='foo' p2=$bar}\n\n{* you can also assign the output *}\n{foobar->meth1 p1='foo' p2=$bar assign='output'}\nthe output was {$output}\nYou can directly access static classes. The syntax is roughly the same as in PHP.
Note
Direct access to PHP classes is not recommended. This ties the underlying application code structure directly to the presentation, and also complicates template syntax. It is recommended to register plugins which insulate templates from PHP classes/objects. Use at your own discretion.
"},{"location":"api/variables/static-class-methods/#examples","title":"Examples","text":"class constant BAR
{assign var=foo value=myclass::BAR}\nmethod result
{assign var=foo value=myclass::method()} \nmethod chaining
{assign var=foo value=myclass::method1()->method2}\nproperty bar of class myclass
{assign var=foo value=myclass::$bar} \nusing Smarty variable bar as class name
{assign var=foo value=$bar::method}\nYou can also use streams to call variables. {$foo:bar} will use the foo://bar stream to get the template variable.
Using a PHP stream for a template variable resource from within a template.
{$foo:bar}\nNB. Support for using streams to call variables is deprecated since Smarty v5.1 and will be removed in a future version.
See also Template Resources
There may be times when you want to print a default value for an empty variable instead of printing nothing, such as printing so that html table backgrounds work properly. Many would use an {if} statement to handle this, but there is a shorthand way with Smarty, using the default variable modifier.
Note
\"Undefined variable\" errors will show an E_NOTICE if not disabled in PHP's error_reporting() level or Smarty's $error_reporting property and a variable had not been assigned to Smarty.
{* the long way *}\n {if $title eq ''}\n \n {else}\n {$title}\n {/if}\n\n {* the short way *}\n {$title|default:' '}\nSee also default modifier and default variable handling.
If a variable is used frequently throughout your templates, applying the default modifier every time it is mentioned can get a bit ugly. You can remedy this by assigning the variable its default value with the {assign} function.
{* do this somewhere at the top of your template *}\n{assign var='title' value=$title|default:'no title'}\n\n{* if $title was empty, it now contains the value \"no title\" when you use it *}\n{$title}\nSee also default modifier and blank variable handling.
When the majority of your templates use the same headers and footers, it is common to split those out into their own templates and {include} them. But what if the header needs to have a different title, depending on what page you are coming from? You can pass the title to the header as an attribute when it is included.
mainpage.tpl - When the main page is drawn, the title of \"Main Page\" is passed to the header.tpl, and will subsequently be used as the title.
{include file='header.tpl' title='Main Page'}\n{* template body goes here *}\n{include file='footer.tpl'}\narchives.tpl - When the archives page is drawn, the title will be \"Archives\". Notice in the archive example, we are using a variable from the archives_page.conf file instead of a hard coded variable.
{config_load file='archive_page.conf'}\n\n{include file='header.tpl' title=#archivePageTitle#}\n{* template body goes here *}\n{include file='footer.tpl'}\nheader.tpl - Notice that \"Smarty News\" is printed if the $title variable is not set, using the default variable modifier.
<html>\n <head>\n <title>{$title|default:'Smarty News'}</title>\n </head>\n<body>\nfooter.tpl
</body>\n</html>\nAs a rule of thumb, always pass dates to Smarty as timestamps. This allows template designers to use the date_format modifier for full control over date formatting, and also makes it easy to compare dates if necessary.
{$startDate|date_format}\nThis will output:
Jan 4, 2009\n{$startDate|date_format:\"%Y/%m/%d\"}\nThis will output:
2009/01/04\nDates can be compared in the template by timestamps with:
{if $order_date < $invoice_date}\n ...do something..\n{/if}\nWhen using {html_select_date} in a template, the programmer will most likely want to convert the output from the form back into timestamp format. Here is a function to help you with that.
<?php\n\n// this assumes your form elements are named\n// startDate_Day, startDate_Month, startDate_Year\n\n$startDate = makeTimeStamp($startDate_Year, $startDate_Month, $startDate_Day);\n\nfunction makeTimeStamp($year='', $month='', $day='')\n{\n if(empty($year)) {\n $year = strftime('%Y');\n }\n if(empty($month)) {\n $month = strftime('%m');\n }\n if(empty($day)) {\n $day = strftime('%d');\n }\n\n return mktime(0, 0, 0, $month, $day, $year);\n}\nSee also {html_select_date}, {html_select_time}, date_format and $smarty.now,
Traditionally, programming templates into your applications goes as follows: First, you accumulate your variables within your PHP application, (maybe with database queries.) Then, you instantiate your Smarty object, assign() the variables and display() the template. So lets say for example we have a stock ticker on our template. We would collect the stock data in our application, then assign these variables in the template and display it. Now wouldn't it be nice if you could add this stock ticker to any application by merely including the template, and not worry about fetching the data up front?
You can do this by writing a custom plugin for fetching the content and assigning it to a template variable.
function.load_ticker.php
<?php\n\n// setup our function for fetching stock data\nfunction fetch_ticker($symbol)\n{\n // put logic here that fetches $ticker_info\n // from some ticker resource\n return $ticker_info;\n}\n\nfunction smarty_function_load_ticker($params, $smarty)\n{\n // call the function\n $ticker_info = fetch_ticker($params['symbol']);\n\n // assign template variable\n $smarty->assign($params['assign'], $ticker_info);\n}\nindex.tpl
{load_ticker symbol='SMARTY' assign='ticker'}\n\nStock Name: {$ticker.name} Stock Price: {$ticker.price}\nSee also: {include}.
Do you ever wonder how your email address gets on so many spam mailing lists? One way spammers collect email addresses is from web pages. To help combat this problem, you can make your email address show up in scrambled javascript in the HTML source, yet it it will look and work correctly in the browser. This is done with the {mailto} plugin.
<div id=\"contact\">Send inquiries to\n{mailto address=$EmailAddress encode='javascript' subject='Hello'}\n</div>\nNote
This method isn\\'t 100% foolproof. A spammer could conceivably program his e-mail collector to decode these values, but not likely.... hopefully..yet ... wheres that quantum computer :-?.
See also escape modifier and {mailto}.
Smarty can catch many errors such as missing tag attributes or malformed variable names. If this happens, you will see an error similar to the following:
Warning: Smarty: [in index.tpl line 4]: syntax error: unknown tag - '%blah'\n in /path/to/smarty/Smarty.class.php on line 1041\n\nFatal error: Smarty: [in index.tpl line 28]: syntax error: missing section name\n in /path/to/smarty/Smarty.class.php on line 1041\nSmarty shows you the template name, the line number and the error. After that, the error consists of the actual line number in the Smarty class that the error occurred.
There are certain errors that Smarty cannot catch, such as missing close tags. These types of errors usually end up in PHP compile-time parsing errors.
Parse error: parse error in /path/to/smarty/templates_c/index.tpl.php on line 75
When you encounter a PHP parsing error, the error line number will correspond to the compiled PHP script, NOT the template itself. Usually you can look at the template and spot the syntax error. Here are some common things to look for: missing close tags for {if}{/if} or {section}{/section}, or syntax of logic within an {if} tag. If you can\\'t find the error, you might have to open the compiled PHP file and go to the line number to figure out where the corresponding error is in the template.
Warning: Smarty error: unable to read resource: \"index.tpl\" in...\nWarning: Smarty error: unable to read resource: \"site.conf\" in...\nThe $template_dir is incorrect, doesn't exist or the file index.tpl is not in the templates/ directory
A {config_load} function is within a template (or configLoad() has been called) and either $config_dir is incorrect, does not exist or site.conf is not in the directory.
Fatal error: Smarty error: the $compile_dir 'templates_c' does not exist,\nor is not a directory...\n$compile_diris incorrectly set, the directory does not exist, or templates_c is a file and not a directory.Fatal error: Smarty error: unable to write to $compile_dir '....\n$compile_dir is not writable by the web server. See the bottom of the installing smarty page for more about permissions.Fatal error: Smarty error: the $cache_dir 'cache' does not exist,\nor is not a directory. in /..\n$caching is enabled and either; the $cache_dir is incorrectly set, the directory does not exist, or cache/ is a file and not a directory.Fatal error: Smarty error: unable to write to $cache_dir '/...\n$caching is enabled and the $cache_dir is not writable by the web server. See the bottom of the installing smarty page for permissions.Warning: filemtime(): stat failed for /path/to/smarty/cache/3ab50a623e65185c49bf17c63c90cc56070ea85c.one.tpl.php \nin /path/to/smarty/libs/sysplugins/smarty_resource.php\n$errno as it should. If, for whatever reason, this is the desired behaviour of your custom error handler, please call muteExpectedErrors() after you've registered your custom error handler.See also debugging.
"},{"location":"designers/chapter-debugging-console/","title":"Debugging Console","text":"There is a debugging console included with Smarty. The console informs you of all the included templates, assigned variables and config file variables for the current invocation of the template. A template file named debug.tpl is included with the distribution of Smarty which controls the formatting of the console.
Set $debugging to TRUE in Smarty, and if needed set $debug_tpl to the template resource path to debug.tpl. When you load the page, a Javascript console window will pop up and give you the names of all the included templates and assigned variables for the current page.
To see the available variables for a particular template, see the {debug} template function. To disable the debugging console, set $debugging to FALSE. You can also temporarily turn on the debugging console by putting SMARTY_DEBUG in the URL if you enable this option with $debugging_ctrl.
Note
The debugging console does not work when you use the fetch() API, only when using display(). It is a set of javascript statements added to the very bottom of the generated template. If you do not like javascript, you can edit the debug.tpl template to format the output however you like. Debug data is not cached and debug.tpl info is not included in the output of the debug console.
Note
The load times of each template and config file are in seconds, or fractions thereof.
See also troubleshooting.
"},{"location":"designers/config-files/","title":"Config Files","text":"Config files are handy for designers to manage global template variables from one file. One example is template colors. Normally if you wanted to change the color scheme of an application, you would have to go through each and every template file and change the colors. With a config file, the colors can be kept in one place, and only one file needs to be updated.
# global variables\npageTitle = \"Main Menu\"\nbodyBgColor = #000000\ntableBgColor = #000000\nrowBgColor = #00ff00\n\n[Customer]\npageTitle = \"Customer Info\"\n\n[Login]\npageTitle = \"Login\"\nfocus = \"username\"\nIntro = \"\"\"This is a value that spans more\n than one line. you must enclose\n it in triple quotes.\"\"\"\n\n# hidden section\n[.Database]\nhost=my.example.com\ndb=ADDRESSBOOK\nuser=php-user\npass=foobar\nValues of config file variables can be in quotes, but not necessary. You can use either single or double quotes. If you have a value that spans more than one line, enclose the entire value with triple quotes (\"\"\"). You can put comments into config files by any syntax that is not a valid config file syntax. We recommend using a # (hash) at the beginning of the line.
The example config file above has two sections. Section names are enclosed in [brackets]. Section names can be arbitrary strings not containing [ or ] symbols. The four variables at the top are global variables, or variables not within a section. These variables are always loaded from the config file. If a particular section is loaded, then the global variables and the variables from that section are also loaded. If a variable exists both as a global and in a section, the section variable is used. If you name two variables the same within a section, the last one will be used unless $config_overwrite is disabled.
Config files are loaded into templates with the built-in template function {config_load} or the API configLoad() function.
You can hide variables or entire sections by prepending the variable name or section name with a period(.) eg [.hidden]. This is useful if your application reads the config files and gets sensitive data from them that the template engine does not need. If you have third parties doing template editing, you can be certain that they cannot read sensitive data from the config file by loading it into the template.
Config files (or resources) are loaded by the same resource facilities as templates. That means that a config file can also be loaded from a db $smarty->configLoad(\"db:my.conf\").
See also {config_load}, $config_overwrite, $default_config_handler_func, getConfigVars(), clearConfig() and configLoad()
You can apply any number of modifiers to a variable. They will be applied in the order they are combined, from left to right. They must be separated with a | (pipe) character.
<?php\n\n$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');\nwhere template is:
{$articleTitle}\n{$articleTitle|upper|spacify}\n{$articleTitle|lower|spacify|truncate}\n{$articleTitle|lower|truncate:30|spacify}\n{$articleTitle|lower|spacify|truncate:30:\". . .\"}\nThe above example will output:
Smokers are Productive, but Death Cuts Efficiency.\nS M O K E R S A R ....snip.... H C U T S E F F I C I E N C Y .\ns m o k e r s a r ....snip.... b u t d e a t h c u t s...\ns m o k e r s a r e p r o d u c t i v e , b u t . . .\ns m o k e r s a r e p. . .\nA simple Smarty template could look like this:
<h1>{$title|escape}</h1>\n<ul>\n {foreach $cities as $city}\n <li>{$city.name|escape} ({$city.population})</li>\n {foreachelse}\n <li>no cities found</li> \n {/foreach}\n</ul>\nAll Smarty template tags are enclosed within delimiters. By default these are { and }, but they can be changed.
For the examples in this manual, we will assume that you are using the default delimiters. In Smarty, all content outside of delimiters is displayed as static content, or unchanged. When Smarty encounters template tags, it attempts to interpret them, and displays the appropriate output in their place.
The basic components of the Smarty syntax are:
It is sometimes desirable or even necessary to have Smarty ignore sections it would otherwise parse. A classic example is embedding Javascript or CSS code in a template. The problem arises as those languages use the { and } characters which are also the default delimiters for Smarty.
Note
A good practice for avoiding escapement altogether is by separating your Javascript/CSS into their own files and use standard HTML methods to access them. This will also take advantage of browser script caching. When you need to embed Smarty variables/functions into your Javascript/CSS, then the following applies.
In Smarty templates, the { and } braces will be ignored so long as they are surrounded by white space. This behavior can be disabled by setting the Smarty class variable $auto_literal to false.
<script>\n // the following braces are ignored by Smarty\n // since they are surrounded by whitespace\n function foobar {\n alert('foobar!');\n }\n // this one will need literal escapement\n {literal}\n function bazzy {alert('foobar!');}\n {/literal}\n</script>\n{literal}..{/literal} blocks are used for escaping blocks of template logic. You can also escape the braces individually with {ldelim}, {rdelim} tags or {$smarty.ldelim},{$smarty.rdelim} variables.
Smarty's default delimiters { and } cleanly represent presentational content. However, if another set of delimiters suit your needs better, you can change them with Smarty's setLeftDelimiter() and setRightDelimiter() methods.
Note
Changing delimiters affects ALL template syntax and escapement. Be sure to clear out cache and compiled files if you decide to change them.
<?php\n\n$smarty->setLeftDelimiter('<!--{');\n$smarty->setRightDelimiter('}-->');\n\n$smarty->assign('foo', 'bar');\n$smarty->assign('name', 'Albert');\n$smarty->display('example.tpl');\nWhere the template is:
Welcome <!--{$name}--> to Smarty\n <script>\n var foo = <!--{$foo}-->;\n function dosomething() {\n alert(\"foo is \" + foo);\n }\n dosomething();\n</script>\nMost of the tags take attributes that specify or modify their behavior. Attributes to Smarty functions are much like HTML attributes. Static values don't have to be enclosed in quotes, but it is required for literal strings. Variables with or without modifiers may also be used, and should not be in quotes. You can even use PHP function results, plugin results and complex expressions.
Some attributes require boolean values (TRUE or FALSE). These can be specified as true and false. If an attribute has no value assigned it gets the default boolean value of true.
{include file=\"header.tpl\"}\n\n{include file=\"header.tpl\" nocache} // is equivalent to nocache=true\n\n{include file=\"header.tpl\" attrib_name=\"attrib value\"}\n\n{include file=$includeFile}\n\n{include file=#includeFile# title=\"My Title\"}\n\n{assign var=foo value={counter}} // plugin result\n\n{assign var=foo value=substr($bar,2,5)} // PHP function result\n\n{assign var=foo value=$bar|strlen} // using modifier\n\n{assign var=foo value=$buh+$bar|strlen} // more complex expression\n\n{html_select_date display_days=true}\n\n{mailto address=\"smarty@example.com\"}\n\n<select name=\"company_id\">\n {html_options options=$companies selected=$company_id}\n</select>\nNote
Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.
"},{"location":"designers/language-basic-syntax/language-syntax-comments/","title":"Comments","text":"Template comments are surrounded by asterisks, and that is surrounded by the delimiter tags like so:
"},{"location":"designers/language-basic-syntax/language-syntax-comments/#examples","title":"Examples","text":"{* this is a comment *}\nSmarty comments are NOT displayed in the final output of the template, unlike <!-- HTML comments -->. These are useful for making internal notes in the templates which no one will see ;-)
{* I am a Smarty comment, I don't exist in the compiled output *}\n<html>\n <head>\n <title>{$title}</title>\n </head>\n<body>\n\n {* another single line smarty comment *}\n <!-- HTML comment that is sent to the browser -->\n\n {* this multiline smarty\n comment is\n not sent to browser\n *}\n\n {*********************************************************\n Multi line comment block with credits block\n @ author: bg@example.com\n @ maintainer: support@example.com\n @ para: var that sets block style\n @ css: the style output\n **********************************************************}\n\n {* The header file with the main logo and stuff *}\n {include file='header.tpl'}\n\n\n {* Dev note: the $includeFile var is assigned in foo.php script *}\n <!-- Displays main content block -->\n {include file=$includeFile}\n\n {* this <select> block is redundant *}\n {*\n <select name=\"company\">\n {html_options options=$vals selected=$selected_id}\n </select>\n *}\n\n <!-- Show header from affiliate is disabled -->\n {* $affiliate|upper *}\n\n {* you cannot nest comments *}\n {*\n <select name=\"company\">\n {* <option value=\"0\">-- none -- </option> *}\n {html_options options=$vals selected=$selected_id}\n </select>\n *}\n\n </body>\n</html>\nVarious basic operators can be applied directly to variable values.
"},{"location":"designers/language-basic-syntax/language-syntax-operators/#examples","title":"Examples","text":"{$foo + 1}\n\n{$foo * $bar}\n\n{$foo->bar - $bar[1] * $baz->foo->bar() -3 * 7}\n\n{if ($foo + $bar.test % $baz * 134232 + 10 + $b + 10)}\n ...\n{/if}\n\n{$foo = $foo + $bar}\nNote
Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.
"},{"location":"designers/language-basic-syntax/language-syntax-operators/#list","title":"List","text":"The following is a list of recognized operators, which must be separated from surrounding elements by spaces. Note that items listed in [brackets] are optional. PHP equivalents are shown where applicable.
Operator Alternates Syntax Example Meaning PHP Equivalent == eq $a eq $b equals == != ne, neq $a neq $b not equals != > gt $a gt $b greater than > < lt $a lt $b less than < >= gte, ge $a ge $b greater than or equal >= <= lte, le $a le $b less than or equal <= === $a === 0 check for identity === ! not not $a negation (unary) ! % mod $a mod $b modulo % is [not] div by $a is not div by 4 divisible by $a % $b == 0 is [not] even $a is not even [not] an even number (unary) $a % 2 == 0 is [not] even by $a is not even by $b grouping level [not] even ($a / $b) % 2 == 0 is [not] odd $a is not odd [not] an odd number (unary) $a % 2 != 0 is [not] odd by $a is not odd by $b [not] an odd grouping ($a / $b) % 2 != 0 is in $a is in $b exists in array in_array($a, $b) is [not] in $a is not in $b does not exist in array !in_array($a, $b)"},{"location":"designers/language-basic-syntax/language-syntax-operators/#ternary","title":"Ternary","text":"You can use the ?: (or ternary) operator to test one expression and present the value of the second or third expression, based on the result of the test.
In other words:
{$test ? \"OK\" : \"FAIL\"}\n$test is set to true, and in FAIL otherwise. There is also a shorthand ?: operator:
{$myVar ?: \"empty\"}\n$myVar is not set or set to something that evaluates to false, such as an empty string. If $myVar is set to something that evaluates to true, the value of $myVar is returned. So, the following will return 'hello': {$myVar=\"hello\"}\n{$myVar ?: \"empty\"}\nIf \"something that evaluates to false\" is to broad a test for you, you can use the ?? (or null coalescing) operator to trigger only if the tested value is undefined or set to null.
{$myVar ?? \"empty\"}\n$myVar is not set or set to null. If $myVar is set to something that evaluates to anything else, the value of $myVar is returned. So, the following will return an empty string (''): {$myVar=\"\"}\n{$myVar ?: \"this is not shown\"}\nSmarty will recognize assigned variables embedded in \"double quotes\" so long as the variable name contains only numbers, letters and under_scores. See naming for more detail.
With any other characters, for example a period(.) or $object->reference, then the variable must be surrounded by `backticks`.
In addition, Smarty does allow embedded Smarty tags in double-quoted strings. This is useful if you want to include variables with modifiers, plugin or PHP function results.
{func var=\"test $foo test\"} // sees $foo\n{func var=\"test $foo_bar test\"} // sees $foo_bar\n{func var=\"test `$foo[0]` test\"} // sees $foo[0]\n{func var=\"test `$foo[bar]` test\"} // sees $foo[bar]\n{func var=\"test $foo.bar test\"} // sees $foo (not $foo.bar)\n{func var=\"test `$foo.bar` test\"} // sees $foo.bar\n{func var=\"test `$foo.bar` test\"|escape} // modifiers outside quotes!\n{func var=\"test {$foo|escape} test\"} // modifiers inside quotes!\n{func var=\"test {time()} test\"} // PHP function result\n{func var=\"test {counter} test\"} // plugin result\n{func var=\"variable foo is {if !$foo}not {/if} defined\"} // Smarty block function\n\n{* will replace $tpl_name with value *}\n{include file=\"subdir/$tpl_name.tpl\"}\n\n{* does NOT replace $tpl_name *}\n{include file='subdir/$tpl_name.tpl'} // vars require double quotes!\n\n{* must have backticks as it contains a dot \".\" *}\n{cycle values=\"one,two,`$smarty.config.myval`\"}\n\n{* must have backticks as it contains a dot \".\" *}\n{include file=\"`$module.contact`.tpl\"}\n\n{* can use variable with dot syntax *}\n{include file=\"`$module.$view`.tpl\"}\nNote
Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.
See also escape.
Every Smarty tag either prints a variable or invokes some sort of function. These are processed and displayed by enclosing the function and its attributes within delimiters like so: {funcname attr1=\"val1\" attr2=\"val2\"}.
{config_load file=\"colors.conf\"}\n\n{include file=\"header.tpl\"}\n\n{if $logged_in}\n Welcome, <span style=\"color:{#fontColor#}\">{$name}!</span>\n{else}\n hi, {$name}\n{/if}\n\n{include file=\"footer.tpl\"}\nBoth built-in functions and custom functions have the same syntax within templates.
Built-in functions are the inner workings of Smarty, such as {if}, {section} and {strip}. There should be no need to change or modify them.
Custom tags are additional tags implemented via plugins. They can be modified to your liking, or you can create new ones. {html_options} is an example of a custom function.
See also registerPlugin()
Template variables start with the $dollar sign. They can contain numbers, letters and underscores, much like a PHP variable. You can reference arrays by index numerically or non-numerically. Also reference object properties and methods.
Config file variables are an exception to the \\$dollar syntax and are instead referenced with surrounding #hashmarks#, or via the $smarty.config variable.
{$foo} <-- displaying a simple variable (non array/object)\n{$foo[4]} <-- display the 5th element of a zero-indexed array\n{$foo.bar} <-- display the \"bar\" key value of an array, similar to PHP $foo['bar']\n{$foo.$bar} <-- display variable key value of an array, similar to PHP $foo[$bar]\n{$foo->bar} <-- display the object property \"bar\"\n{$foo->bar()} <-- display the return value of object method \"bar\"\n{#foo#} <-- display the config file variable \"foo\"\n{$smarty.config.foo} <-- synonym for {#foo#}\n{$foo[bar]} <-- syntax only valid in a section loop, see {section}\n{assign var=foo value='baa'}{$foo} <-- displays \"baa\", see {assign}\n\nMany other combinations are allowed\n\n{$foo.bar.baz}\n{$foo.$bar.$baz}\n{$foo[4].baz}\n{$foo[4].$baz}\n{$foo.bar.baz[4]}\n{$foo->bar($baz,2,$bar)} <-- passing parameters\n{\"foo\"} <-- static values are allowed\n\n{* display the server variable \"SERVER_NAME\" ($_SERVER['SERVER_NAME'])*}\n{$smarty.server.SERVER_NAME}\n\nMath and embedding tags:\n\n{$x+$y} // will output the sum of x and y.\n{assign var=foo value=$x+$y} // in attributes \n{$foo[$x+3]} // as array index\n{$foo={counter}+3} // tags within tags\n{$foo=\"this is message {counter}\"} // tags within double quoted strings\n\nDefining Arrays:\n\n{assign var=foo value=[1,2,3]}\n{assign var=foo value=['y'=>'yellow','b'=>'blue']}\n{assign var=foo value=[1,[9,8],3]} // can be nested\n\nShort variable assignment:\n\n{$foo=$bar+2}\n{$foo = strlen($bar)} // function in assignment\n{$foo = myfunct( ($x+$y)*3 )} // as function parameter \n{$foo.bar=1} // assign to specific array element\n{$foo.bar.baz=1} \n{$foo[]=1} // appending to an array\n\nSmarty \"dot\" syntax (note: embedded {} are used to address ambiguities):\n\n{$foo.a.b.c} => $foo['a']['b']['c'] \n{$foo.a.$b.c} => $foo['a'][$b]['c'] // with variable index\n{$foo.a.{$b+4}.c} => $foo['a'][$b+4]['c'] // with expression as index\n{$foo.a.{$b.c}} => $foo['a'][$b['c']] // with nested index\n\nPHP-like syntax, alternative to \"dot\" syntax:\n\n{$foo[1]} // normal access\n{$foo['bar']}\n{$foo['bar'][1]}\n{$foo[$x+$x]} // index may contain any expression\n{$foo[$bar[1]]} // nested index\n{$foo[section_name]} // smarty {section} access, not array access!\n\nVariable variables:\n\n$foo // normal variable\n$foo_{$bar} // variable name containing other variable \n$foo_{$x+$y} // variable name containing expressions \n$foo_{$bar}_buh_{$blar} // variable name with multiple segments\n{$foo_{$x}} // will output the variable $foo_1 if $x has a value of 1.\n\nObject chaining:\n\n{$object->method1($x)->method2($y)}\nNote
Although Smarty can handle some very complex expressions and syntax, it is a good rule of thumb to keep the template syntax minimal and focused on presentation. If you find your template syntax getting too complex, it may be a good idea to move the bits that do not deal explicitly with presentation to PHP by way of plugins or modifiers.
Request variables such as $_GET, $_SESSION, etc are available via the reserved $smarty variable.
See also $smarty, config variables {assign} and assign().
Smarty comes with several built-in functions. These built-in functions are the integral part of the smarty template engine. They are compiled into corresponding inline PHP code for maximum performance.
You cannot create your own custom tags with the same name; and you should not need to modify the built-in functions.
A few of these functions have an assign attribute which collects the result the function to a named template variable instead of being output; much like the {assign} function.
{append} is used for creating or appending template variable arrays during the execution of a template.
Note
Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion.
"},{"location":"designers/language-builtin-functions/language-function-append/#examples","title":"Examples","text":"{append var='name' value='Bob' index='first'}\n{append var='name' value='Meyer' index='last'}\n// or \n{append 'name' 'Bob' index='first'} {* short-hand *}\n{append 'name' 'Meyer' index='last'} {* short-hand *}\n\nThe first name is {$name.first}.<br>\nThe last name is {$name.last}.\nThe above example will output:
The first name is Bob.\nThe last name is Meyer.\nSee also append() and getTemplateVars().
{assign} or {$var=...} is used for assigning template variables during the execution of a template.
Note
Assignment of variables in-template is essentially placing application logic into the presentation that may be better handled in PHP. Use at your own discretion.
"},{"location":"designers/language-builtin-functions/language-function-assign/#examples","title":"Examples","text":"{assign var=\"name\" value=\"Bob\"} {* or *}\n{assign \"name\" \"Bob\"} {* short-hand, or *}\n{$name='Bob'}\n\nThe value of $name is {$name}.\nThe above example will output:
The value of $name is Bob.\n{assign var=\"name\" value=\"Bob\" nocache} {* or *}\n{assign \"name\" \"Bob\" nocache} {* short-hand, or *}\n{$name='Bob' nocache}\n\nThe value of $name is {$name}.\nThe value of $name is Bob.\n{assign var=running_total value=$running_total+$some_array[$row].some_value} {* or *}\n{$running_total=$running_total+$some_array[row].some_value}\nVariables assigned in the included template will be seen in the including template.
{include file=\"sub_template.tpl\"}\n\n{* display variable assigned in sub_template *}\n{$foo}<br>\nThe template above includes the example sub_template.tpl below:
{* foo will be known also in the including template *}\n{assign var=\"foo\" value=\"something\" scope=parent}\n{$foo=\"something\" scope=parent}\n\n{* bar is assigned only local in the including template *}\n{assign var=\"bar\" value=\"value\"} {* or *}\n{$var=\"value\"}\nYou can assign a variable to root of the current root tree. The variable is seen by all templates using the same root tree.
{assign var=foo value=\"bar\" scope=\"root\"}\nA global variable is seen by all templates.
{assign var=foo value=\"bar\" scope=\"global\"} {* or *}\n{assign \"foo\" \"bar\" scope=\"global\"} {* short-hand, or *}\n{$foo=\"bar\" scope=\"global\"}\nFor more information on variable scope, please read the page on variable scopes.
To access {assign} variables from a php script use getTemplateVars(). Here's the template that creates the variable $foo.
{assign var=\"foo\" value=\"Smarty\"} {* or *}\n{$foo=\"Smarty\"}\nThe template variables are only available after/during template execution as in the following script.
<?php\n\n// this will output nothing as the template has not been executed\necho $smarty->getTemplateVars('foo');\n\n// fetch the template to a variable\n$whole_page = $smarty->fetch('index.tpl');\n\n// this will output 'smarty' as the template has been executed\necho $smarty->getTemplateVars('foo');\n\n$smarty->assign('foo','Even smarter');\n\n// this will output 'Even smarter'\necho $smarty->getTemplateVars('foo');\nThe following functions can also optionally assign template variables: {capture}, {include}, {counter}, {cycle}, {eval}, {fetch}, {math} and {textformat}.
See also {append}, assign() and getTemplateVars().
{block} is used to define a named area of template source for template inheritance. For details see section of Template Inheritance.
The {block} template source area of a child template will replace the corresponding areas in the parent template(s).
Optionally {block} areas of child and parent templates can be merged into each other. You can append or prepend the parent {block} content by using the append or prepend option flag with the child's {block} definition. With {$smarty.block.parent} the {block} content of the parent template can be inserted at any location of the child {block} content. {$smarty.block.child} inserts the {block} content of the child template at any location of the parent {block}.
{blocks}'s can be nested.
Note
The assign attribute only works on the block that actually gets executed, so you may need to add it to each child block as well.
"},{"location":"designers/language-builtin-functions/language-function-block/#option-flags-in-child-templates-only","title":"Option Flags (in child templates only):","text":"Name Description append The{block} content will be appended to the content of the parent template {block} prepend The {block} content will be prepended to the content of the parent template {block} hide Ignore the block content if no child block of same name is existing. nocache Disables caching of the {block} content"},{"location":"designers/language-builtin-functions/language-function-block/#examples","title":"Examples","text":"parent.tpl
<html>\n <head>\n <title>{block name=\"title\"}Default Title{/block}</title>\n <title>{block \"title\"}Default Title{/block}</title> {* short-hand *}\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\"}\n Page Title\n {/block}\nThe result would look like
<html>\n <head>\n <title>Page Title</title>\n </head>\n </html>\nparent.tpl
<html>\n <head>\n <title>{block name=\"title\"}Title - {/block}</title>\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\" append}\n Page Title\n {/block}\nThe result would look like
<html>\n <head>\n <title>Title - Page Title</title>\n </head>\n </html>\nparent.tpl
<html>\n <head>\n <title>{block name=\"title\"} is my title{/block}</title>\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\" prepend}\n Page Title\n {/block}\nThe result would look like
<html>\n <head>\n <title>Page title is my titel</title>\n </head>\n </html>\nparent.tpl
<html>\n <head>\n <title>{block name=\"title\"}The {$smarty.block.child} was inserted here{/block}</title>\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\"}\n Child Title\n {/block}\nThe result would look like
<html>\n <head>\n <title>The Child Title was inserted here</title>\n </head>\n </html>\nparent.tpl
<html>\n <head>\n <title>{block name=\"title\"}Parent Title{/block}</title>\n </head>\n </html>\nchild.tpl
{extends file=\"parent.tpl\"} \n {block name=\"title\"}\n You will see now - {$smarty.block.parent} - here\n {/block}\nThe result would look like
<html>\n <head>\n <title>You will see now - Parent Title - here</title>\n </head>\n </html>\nSee also Template Inheritance, $smarty.block.parent, $smarty.block.child, and {extends}
{call} is used to call a template function defined by the {function} tag just like a plugin function.
Note
Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The {call} tag must be used to call a template function defined externally from the given template. Otherwise you can directly use the function as {funcname ...} in the template.
The {call} tag must have the name attribute which contains the name of the template function.
Values for variables can be passed to the template function as attributes.
{* define the function *}\n {function name=menu level=0}\n <ul class=\"level{$level}\">\n {foreach $data as $entry}\n {if is_array($entry)}\n <li>{$entry@key}</li>\n {call name=menu data=$entry level=$level+1}\n {else}\n <li>{$entry}</li>\n {/if}\n {/foreach}\n </ul>\n {/function}\n\n {* create an array to demonstrate *}\n {$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>\n ['item3-3-1','item3-3-2']],'item4']}\n\n {* run the array through the function *}\n {call name=menu data=$menu}\n {call menu data=$menu} {* short-hand *}\nWill generate the following output
* item1\n * item2\n * item3\n o item3-1\n o item3-2\n o item3-3\n + item3-3-1\n + item3-3-2\n * item4\nSee also {function}.
{capture} is used to collect the output of the template between the tags into a variable instead of displaying it. Any content between {capture name='foo'} and {/capture} is collected into the variable specified in the name attribute.
The captured content can be used in the template from the variable $smarty.capture.foo where \"foo\" is the value passed in the name attribute. If you do not supply the name attribute, then \"default\" will be used as the name ie $smarty.capture.default.
{capture}'s can be nested.
{* we don't want to print a div tag unless content is displayed *}\n{capture name=\"banner\"}\n{capture \"banner\"} {* short-hand *}\n {include file=\"get_banner.tpl\"}\n{/capture}\n\n{if $smarty.capture.banner ne \"\"}\n<div id=\"banner\">{$smarty.capture.banner}</div>\n{/if}\nThis example demonstrates the capture function.
{capture name=some_content assign=popText}\n{capture some_content assign=popText} {* short-hand *}\nThe server is {$my_server_name|upper} at {$my_server_addr}<br>\nYour ip is {$my_ip}.\n{/capture}\n<a href=\"#\">{$popText}</a>\nThis example also demonstrates how multiple calls of capture can be used to create an array with captured content.
{capture append=\"foo\"}hello{/capture}I say just {capture append=\"foo\"}world{/capture}\n{foreach $foo as $text}{$text} {/foreach}\nThe above example will output:
I say just hello world\nSee also $smarty.capture, {eval}, {fetch}, fetch() and {assign}.
{config_load} is used for loading config #variables# from a configuration file into the template.
The example.conf file.
#this is config file comment\n\n# global variables\npageTitle = \"Main Menu\"\nbodyBgColor = #000000\ntableBgColor = #000000\nrowBgColor = #00ff00\n\n#customer variables section\n[Customer]\npageTitle = \"Customer Info\"\nand the template
{config_load file=\"example.conf\"}\n{config_load \"example.conf\"} {* short-hand *}\n\n<html>\n <title>{#pageTitle#|default:\"No title\"}</title>\n <body bgcolor=\"{#bodyBgColor#}\">\n <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n <tr bgcolor=\"{#rowBgColor#}\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nConfig Files may also contain sections. You can load variables from within a section with the added attribute section. Note that global config variables are always loaded along with section variables, and same-named section variables overwrite the globals.
Note
Config file sections and the built-in template function called {section} have nothing to do with each other, they just happen to share a common naming convention.
{config_load file='example.conf' section='Customer'}\n{config_load 'example.conf' 'Customer'} {* short-hand *}\n\n<html>\n <title>{#pageTitle#}</title>\n <body bgcolor=\"{#bodyBgColor#}\">\n <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n <tr bgcolor=\"{#rowBgColor#}\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nSee $config_overwrite to create arrays of config file variables.
See also the config files page, config variables page, $config_dir, getConfigVars() and configLoad().
{debug} dumps the debug console to the page. This works regardless of the debug settings in the php script. Since this gets executed at runtime, this is only able to show the assigned variables; not the templates that are in use. However, you can see all the currently available variables within the scope of a template.
If caching is enabled and a page is loaded from cache {debug} does show only the variables which assigned for the cached page.
In order to see also the variables which have been locally assigned within the template it does make sense to place the {debug} tag at the end of the template.
See also the debugging console page.
"},{"location":"designers/language-builtin-functions/language-function-extends/","title":"{extends}","text":"{extends} tags are used in child templates in template inheritance for extending parent templates. For details see section of Template Inheritance.
The {extends} tag must be on the first line of the template.
If a child template extends a parent template with the {extends} tag it may contain only {block} tags. Any other template content is ignored.
Use the syntax for template resources to extend files outside the $template_dir directory.
Note
When extending a variable parent like {extends file=$parent_file}, make sure you include $parent_file in the $compile_id. Otherwise, Smarty cannot distinguish between different $parent_files.
{extends file='parent.tpl'}\n{extends 'parent.tpl'} {* short-hand *}\nSee also Template Inheritance and {block}.
The {for}{forelse} tag is used to create simple loops. The following different formats are supported:
{for $var=$start to $end} simple loop with step size of 1.
{for $var=$start to $end step $step} loop with individual step size.
{forelse} is executed when the loop is not iterated.
{for} loop"},{"location":"designers/language-builtin-functions/language-function-for/#examples","title":"Examples","text":"<ul>\n {for $foo=1 to 3}\n <li>{$foo}</li>\n {/for}\n</ul>\nThe above example will output:
<ul>\n <li>1</li>\n <li>2</li>\n <li>3</li>\n</ul>\n<?php\n$smarty->assign('to',10);\n<ul>\n {for $foo=3 to $to max=3}\n <li>{$foo}</li>\n {/for}\n</ul>\nThe above example will output:
<ul>\n <li>3</li>\n <li>4</li>\n <li>5</li>\n</ul>\n<?php\n$smarty->assign('start',10);\n$smarty->assign('to',5);\n<ul>\n {for $foo=$start to $to}\n <li>{$foo}</li>\n {forelse}\n no iteration\n {/for}\n</ul>\nThe above example will output:
no iteration\nSee also {foreach}, {section} and {while}
{foreach} is used for looping over arrays of data. {foreach} has a simpler and cleaner syntax than the {section} loop, and can also loop over associative arrays.
{foreach} loop"},{"location":"designers/language-builtin-functions/language-function-foreach/#examples","title":"Examples","text":"{foreach $arrayvar as $itemvar}\n {$itemvar|escape}\n{/foreach}\n\n{foreach $arrayvar as $keyvar=>$itemvar}\n {$keyvar}: {$itemvar|escape}\n{/foreach}\nNote
This foreach syntax does not accept any named attributes. This syntax is new to Smarty 3, however the Smarty 2.x syntax {foreach from=$myarray key=\"mykey\" item=\"myitem\"} is still supported.
{foreach} loops can be nested.
The array variable, usually an array of values, determines the number of times {foreach} will loop. You can also pass an integer for arbitrary loops.
{foreachelse} is executed when there are no values in the array variable.
{foreach} properties are @index, @iteration, @first, @last, @show, @total.
{foreach} constructs are {break}, {continue}.
Instead of specifying the key variable you can access the current key of the loop item by {$item@key} (see examples below).
Note
The $var@property syntax is new to Smarty 3, however when using the Smarty 2 {foreach from=$myarray key=\"mykey\" item=\"myitem\"} style syntax, the $smarty.foreach.name.property syntax is still supported.
Note
Although you can retrieve the array key with the syntax {foreach $myArray as $myKey => $myValue}, the key is always available as $myValue@key within the foreach loop.
<?php\n$arr = array('red', 'green', 'blue');\n$smarty->assign('myColors', $arr);\nTemplate to output $myColors in an un-ordered list
<ul>\n {foreach $myColors as $color}\n <li>{$color}</li>\n {/foreach}\n</ul>\nThe above example will output:
<ul>\n <li>red</li>\n <li>green</li>\n <li>blue</li>\n</ul>\n<?php\n$people = array('fname' => 'John', 'lname' => 'Doe', 'email' => 'j.doe@example.com');\n$smarty->assign('myPeople', $people);\nTemplate to output $myArray as key/value pairs.
<ul>\n {foreach $myPeople as $value}\n <li>{$value@key}: {$value}</li>\n {/foreach}\n</ul>\nThe above example will output:
<ul>\n <li>fname: John</li>\n <li>lname: Doe</li>\n <li>email: j.doe@example.com</li>\n</ul>\nAssign an array to Smarty, the key contains the key for each looped value.
<?php\n $smarty->assign(\n 'contacts', \n [\n ['phone' => '555-555-1234', 'fax' => '555-555-5678', 'cell' => '555-555-0357'],\n ['phone' => '800-555-4444', 'fax' => '800-555-3333', 'cell' => '800-555-2222'],\n ]\n );\nThe template to output $contact.
{* key always available as a property *}\n{foreach $contacts as $contact}\n {foreach $contact as $value}\n {$value@key}: {$value}\n {/foreach}\n{/foreach}\n\n{* accessing key the PHP syntax alternate *}\n{foreach $contacts as $contact}\n {foreach $contact as $key => $value}\n {$key}: {$value}\n {/foreach}\n{/foreach}\nEither of the above examples will output:
phone: 555-555-1234\n fax: 555-555-5678\n cell: 555-555-0357\n phone: 800-555-4444\n fax: 800-555-3333\n cell: 800-555-2222\nA database (PDO) example of looping over search results. This example is looping over a PHP iterator instead of an array().
<?php \n use Smarty\\Smarty;\n\n $smarty = new Smarty; \n\n $dsn = 'mysql:host=localhost;dbname=test'; \n $login = 'test'; \n $passwd = 'test'; \n\n // setting PDO to use buffered queries in mysql is \n // important if you plan on using multiple result cursors \n // in the template. \n\n $db = new PDO($dsn, $login, $passwd, array( \n PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true)); \n\n $res = $db->prepare(\"select * from users\"); \n $res->execute(); \n $res->setFetchMode(PDO::FETCH_LAZY); \n\n // assign to smarty \n $smarty->assign('res',$res); \n\n $smarty->display('index.tpl');?>\n{foreach $res as $r} \n {$r.id} \n {$r.name}\n{foreachelse}\n .. no results .. \n{/foreach}\nThe above is assuming the results contain the columns named id and name.
What is the advantage of an iterator vs. looping over a plain old array? With an array, all the results are accumulated into memory before being looped. With an iterator, each result is loaded/released within the loop. This saves processing time and memory, especially for very large result sets.
"},{"location":"designers/language-builtin-functions/language-function-foreach/#index","title":"@index","text":"index contains the current array index, starting with zero.
{* output empty row on the 4th iteration (when index is 3) *}\n<table>\n {foreach $items as $i}\n {if $i@index eq 3}\n {* put empty table row *}\n <tr><td>nbsp;</td></tr>\n {/if}\n <tr><td>{$i.label}</td></tr>\n {/foreach}\n</table>\niteration contains the current loop iteration and always starts at one, unlike index. It is incremented by one on each iteration.
The \"is div by\" operator can be used to detect a specific iteration. Here we bold-face the name every 4th iteration.
{foreach $myNames as $name}\n {if $name@iteration is div by 4}\n <b>{$name}</b>\n {/if}\n {$name}\n{/foreach}\nThe \"is even by\" and \"is odd by\" operators can be used to alternate something every so many iterations. Choosing between even or odd rotates which one starts. Here we switch the font color every 3rd iteration.
{foreach $myNames as $name}\n {if $name@index is even by 3}\n <span style=\"color: #000\">{$name}</span>\n {else}\n <span style=\"color: #eee\">{$name}</span>\n {/if}\n {/foreach}\nThis will output something similar to this:
<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #000\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n<span style=\"color: #eee\">...</span>\n...\nfirst is TRUE if the current {foreach} iteration is the initial one. Here we display a table header row on the first iteration.
{* show table header at first iteration *}\n<table>\n {foreach $items as $i}\n {if $i@first}\n <tr>\n <th>key</td>\n <th>name</td>\n </tr>\n {/if}\n <tr>\n <td>{$i@key}</td>\n <td>{$i.name}</td>\n </tr>\n {/foreach}\n</table>\nlast is set to TRUE if the current {foreach} iteration is the final one. Here we display a horizontal rule on the last iteration.
{* Add horizontal rule at end of list *}\n{foreach $items as $item}\n <a href=\"#{$item.id}\">{$item.name}</a>{if $item@last}<hr>{else},{/if}\n{foreachelse}\n ... no items to loop ...\n{/foreach}\nThe show show property can be used after the execution of a {foreach} loop to detect if data has been displayed or not. show is a boolean value.
<ul>\n {foreach $myArray as $name}\n <li>{$name}</li>\n {/foreach}\n</ul>\n{if $name@show} do something here if the array contained data {/if}\ntotal contains the number of iterations that this {foreach} will loop. This can be used inside or after the {foreach}.
{* show number of rows at end *}\n{foreach $items as $item}\n {$item.name}<hr/>\n {if $item@last}\n <div id=\"total\">{$item@total} items</div>\n {/if}\n{foreachelse}\n ... no items to loop ...\n{/foreach}\nSee also {section}, {for} and {while}
{break} aborts the iteration of the array
{$data = [1,2,3,4,5]}\n {foreach $data as $value}\n {if $value == 3}\n {* abort iterating the array *}\n {break}\n {/if}\n {$value}\n {/foreach}\n {*\n prints: 1 2\n *}\n{continue} leaves the current iteration and begins with the next iteration.
{$data = [1,2,3,4,5]}\n {foreach $data as $value}\n {if $value == 3}\n {* skip this iteration *}\n {continue}\n {/if}\n {$value}\n {/foreach}\n {*\n prints: 1 2 4 5\n *}\n{function} is used to create functions within a template and call them just like a plugin function. Instead of writing a plugin that generates presentational content, keeping it in the template is often a more manageable choice. It also simplifies data traversal, such as deeply nested menus.
Note
Template functions are defined global. Since the Smarty compiler is a single-pass compiler, The {call} tag must be used to call a template function defined externally from the given template. Otherwise, you can directly use the function as {funcname ...} in the template.
The {function} tag must have the name attribute which contains the name of the template function. A tag with this name can be used to call the template function.
Default values for variables can be passed to the template function as attributes. Like in PHP function declarations you can only use scalar values as default. The default values can be overwritten when the template function is being called.
You can use all variables from the calling template inside the template function. Changes to variables or new created variables inside the template function have local scope and are not visible inside the calling template after the template function is executed.
Note
You can pass any number of parameter to the template function when it is called. The parameter variables must not be declared in the {funcname ...} tag unless you what to use default values. Default values must be scalar and can not be variable. Variables must be passed when the template is called.
{* define the function *}\n{function name=menu level=0}\n{function menu level=0} {* short-hand *}\n <ul class=\"level{$level}\">\n {foreach $data as $entry}\n {if is_array($entry)}\n <li>{$entry@key}</li>\n {menu data=$entry level=$level+1}\n {else}\n <li>{$entry}</li>\n {/if}\n {/foreach}\n </ul>\n{/function}\n\n{* create an array to demonstrate *}\n{$menu = ['item1','item2','item3' => ['item3-1','item3-2','item3-3' =>\n['item3-3-1','item3-3-2']],'item4']}\n\n{* run the array through the function *}\n{menu data=$menu}\nWill generate the following output
* item1\n* item2\n* item3\n o item3-1\n o item3-2\n o item3-3\n + item3-3-1\n + item3-3-2\n* item4\nSee also {call}
{if} statements in Smarty have much the same flexibility as PHP if statements, with a few added features for the template engine. Every {if} must be paired with a matching {/if}. {else} and {elseif} are also permitted. All operators are recognized, such as ==, ||, or, &&, and, etc and you can use modifiers as functions, such as is_array().
{if $name eq 'Fred'}\n Welcome Sir.\n{elseif $name eq 'Wilma'}\n Welcome Ma'am.\n{else}\n Welcome, whatever you are.\n{/if}\n\n{* an example with \"or\" logic *}\n{if $name eq 'Fred' or $name eq 'Wilma'}\n ...\n{/if}\n\n{* same as above *}\n{if $name == 'Fred' || $name == 'Wilma'}\n ...\n{/if}\n\n\n{* parenthesis are allowed *}\n{if ( $amount < 0 or $amount > 1000 ) and $volume >= #minVolAmt#}\n ...\n{/if}\n\n\n{* you can also embed php function calls *}\n{if count($var) gt 0}\n ...\n{/if}\n\n{* check for array. *}\n{if is_array($foo) }\n .....\n{/if}\n\n{* check for not null. *}\n{if isset($foo) }\n .....\n{/if}\n\n\n{* test if values are even or odd *}\n{if $var is even}\n ...\n{/if}\n{if $var is odd}\n ...\n{/if}\n{if $var is not odd}\n ...\n{/if}\n\n\n{* test if var is divisible by 4 *}\n{if $var is div by 4}\n ...\n{/if}\n\n\n{*\n test if var is even, grouped by two. i.e.,\n 0=even, 1=even, 2=odd, 3=odd, 4=even, 5=even, etc.\n*}\n{if $var is even by 2}\n ...\n{/if}\n\n{* 0=even, 1=even, 2=even, 3=odd, 4=odd, 5=odd, etc. *}\n{if $var is even by 3}\n ...\n{/if}\n\n{if isset($name) && $name == 'Blog'}\n {* do something *}\n{elseif $name == $foo}\n {* do something *}\n{/if}\n\n{if is_array($foo) && count($foo) > 0}\n {* do a foreach loop *}\n{/if}\n{include} tags are used for including other templates in the current template. Any variables available in the current template are also available within the included template.
The {include} tag must have the file attribute which contains the template resource path.
Setting the optional assign attribute specifies the template variable that the output of {include} is assigned to, instead of being displayed. Similar to {assign}.
Variables can be passed to included templates as attributes. Any variables explicitly passed to an included template are only available within the scope of the included file. Attribute variables override current template variables, in the case when they are named the same.
You can use all variables from the including template inside the included template. But changes to variables or new created variables inside the included template have local scope and are not visible inside the including template after the {include} statement. This default behaviour can be changed for all variables assigned in the included template by using the scope attribute at the {include} statement or for individual variables by using the scope attribute at the {assign} statement. The later is useful to return values from the included template to the including template.
Use the syntax for template resources to {include} files outside of the $template_dir directory.
<html>\n <head>\n <title>{$title}</title>\n </head>\n <body>\n {include file='page_header.tpl'}\n\n {* body of template goes here, the $tpl_name variable\n is replaced with a value eg 'contact.tpl'\n *}\n {include file=\"$tpl_name.tpl\"}\n\n {* using shortform file attribute *}\n {include 'page_footer.tpl'}\n </body>\n</html>\n{include 'links.tpl' title='Newest links' links=$link_array}\n{* body of template goes here *}\n{include 'footer.tpl' foo='bar'}\nThe template above includes the example links.tpl below
<div id=\"box\">\n <h3>{$title}</h3>\n <ul>\n {foreach from=$links item=l}\n .. do stuff ...\n {/foreach}\n </ul>\n</div>\n{include 'sub_template.tpl' scope=parent}\n...\n{* display variables assigned in sub_template *}\n{$foo}<br>\n{$bar}<br>\n...\nThe template above includes the example sub_template.tpl below
...\n{assign var=foo value='something'}\n{assign var=bar value='value'}\n...\nThe included template will not be cached.
{include 'sub_template.tpl' nocache}\n...\nIn this example included template will be cached with an individual cache lifetime of 500 seconds.
{include 'sub_template.tpl' cache_lifetime=500}\n...\nIn this example included template will be cached independent of the global caching setting.
{include 'sub_template.tpl' caching}\n...\nThis example assigns the contents of nav.tpl to the $navbar variable, which is then output at both the top and bottom of the page.
<body>\n {include 'nav.tpl' assign=navbar}\n {include 'header.tpl' title='Smarty is cool'}\n {$navbar}\n {* body of template goes here *}\n {$navbar}\n {include 'footer.tpl'}\n</body>\nThis example includes another template relative to the directory of the current template.
{include 'template-in-a-template_dir-directory.tpl'}\n{include './template-in-same-directory.tpl'}\n{include '../template-in-parent-directory.tpl'}\n{* absolute filepath *}\n{include file='/usr/local/include/templates/header.tpl'}\n\n{* absolute filepath (same thing) *}\n{include file='file:/usr/local/include/templates/header.tpl'}\n\n{* windows absolute filepath (MUST use \"file:\" prefix) *}\n{include file='file:C:/www/pub/templates/header.tpl'}\n\n{* include from template resource named \"db\" *}\n{include file='db:header.tpl'}\n\n{* include a $variable template - eg $module = 'contacts' *}\n{include file=\"$module.tpl\"}\n\n{* wont work as its single quotes ie no variable substitution *}\n{include file='$module.tpl'}\n\n{* include a multi $variable template - eg amber/links.view.tpl *}\n{include file=\"$style_dir/$module.$view.tpl\"}\nSee also template resources and componentized templates.
"},{"location":"designers/language-builtin-functions/language-function-ldelim/","title":"{ldelim}, {rdelim}","text":"{ldelim} and {rdelim} are used for escaping template delimiters, by default { and }. You can also use {literal}{/literal} to escape blocks of text eg Javascript or CSS. See also the complementary {$smarty.ldelim}.
{* this will print literal delimiters out of the template *}\n\n{ldelim}funcname{rdelim} is how functions look in Smarty!\nThe above example will output:
{funcname} is how functions look in Smarty!\nAnother example with some Javascript
<script>\nfunction foo() {ldelim}\n ... code ...\n{rdelim}\n</script>\nwill output
<script>\nfunction foo() {\n .... code ...\n}\n</script>\n<script>\n function myJsFunction(){ldelim}\n alert(\"The server name\\n{$smarty.server.SERVER_NAME|escape:javascript}\\n{$smarty.server.SERVER_ADDR|escape:javascript}\");\n {rdelim}\n</script>\n<a href=\"javascript:myJsFunction()\">Click here for Server Info</a>\nSee also {literal} and escaping Smarty parsing.
{literal} tags allow a block of data to be taken literally. This is typically used around Javascript or stylesheet blocks where {curly braces} would interfere with the template delimiter syntax. Anything within {literal}{/literal} tags is not interpreted, but displayed as-is. If you need template tags embedded in a {literal} block, consider using {ldelim}{rdelim} to escape the individual delimiters instead.
Note
{literal}{/literal} tags are normally not necessary, as Smarty ignores delimiters that are surrounded by whitespace. Be sure your javascript and CSS curly braces are surrounded by whitespace. This is new behavior to Smarty 3.
<script>\n // the following braces are ignored by Smarty\n // since they are surrounded by whitespace\n function myFoo {\n alert('Foo!');\n }\n // this one will need literal escapement\n {literal}\n function myBar {alert('Bar!');}\n {/literal}\n</script>\nSee also {ldelim} {rdelim} and the escaping Smarty parsing page.
{nocache} is used to disable caching of a template section. Every {nocache} must be paired with a matching {/nocache}.
Note
Be sure any variables used within a non-cached section are also assigned from PHP when the page is loaded from the cache.
Today's date is\n{nocache}\n{$smarty.now|date_format}\n{/nocache}\nThe above code will output the current date on a cached page.
See also the caching section.
"},{"location":"designers/language-builtin-functions/language-function-section/","title":"{section}, {sectionelse}","text":"A {section} is for looping over sequentially indexed arrays of data, unlike {foreach} which is used to loop over a single associative array. Every {section} tag must be paired with a closing {/section} tag.
Note
The {foreach} loop can do everything a {section} loop can do, and has a simpler and easier syntax. It is usually preferred over the {section} loop.
Note
{section} loops cannot loop over associative arrays, they must be numerically indexed, and sequential (0,1,2,...). For associative arrays, use the {foreach} loop.
{section} loop Required attributes are name and loop.
The name of the {section} can be anything you like, made up of letters, numbers and underscores, like PHP variables.
{section}'s can be nested, and the nested {section} names must be unique from each other.
The loop attribute, usually an array of values, determines the number of times the {section} will loop. You can also pass an integer as the loop value.
When printing a variable within a {section}, the {section} name must be given next to variable name within [brackets].
{sectionelse} is executed when there are no values in the loop variable.
A {section} also has its own variables that handle {section} properties. These properties are accessible as: {$smarty.section.name.property} where \"name\" is the attribute name.
{section} properties are index, index_prev, index_next, iteration, first, last, rownum, loop, show, total.
assign() an array to Smarty
<?php\n$data = [1000, 1001, 1002];\n$smarty->assign('custid', $data);\nThe template that outputs the array
{* this example will print out all the values of the $custid array *}\n{section name=customer loop=$custid}\n{section customer $custid} {* short-hand *}\n id: {$custid[customer]}<br />\n{/section}\n<hr />\n{* print out all the values of the $custid array reversed *}\n{section name=foo loop=$custid step=-1}\n{section foo $custid step=-1} {* short-hand *}\n {$custid[foo]}<br />\n{/section}\nThe above example will output:
id: 1000<br />\nid: 1001<br />\nid: 1002<br />\n<hr />\nid: 1002<br />\nid: 1001<br />\nid: 1000<br />\n{section name=foo start=10 loop=20 step=2}\n {$smarty.section.foo.index}\n{/section}\n<hr />\n{section name=bar loop=21 max=6 step=-2}\n {$smarty.section.bar.index}\n{/section}\nThe above example will output:
10 12 14 16 18\n<hr />\n20 18 16 14 12 10\nThe name of the {section} can be anything you like, see PHP variables. It is used to reference the data within the {section}.
{section name=anything loop=$myArray}\n {$myArray[anything].foo}\n {$name[anything]}\n {$address[anything].bar}\n{/section}\nThis is an example of printing an associative array of data with a {section}. Following is the php script to assign the $contacts array to Smarty.
<?php\n$data = [\n ['name' => 'John Smith', 'home' => '555-555-5555',\n 'cell' => '666-555-5555', 'email' => 'john@myexample.com'],\n ['name' => 'Jack Jones', 'home' => '777-555-5555',\n 'cell' => '888-555-5555', 'email' => 'jack@myexample.com'],\n ['name' => 'Jane Munson', 'home' => '000-555-5555',\n 'cell' => '123456', 'email' => 'jane@myexample.com']\n];\n$smarty->assign('contacts',$data);\nThe template to output $contacts
{section name=customer loop=$contacts}\n<p>\n name: {$contacts[customer].name}<br />\n home: {$contacts[customer].home}<br />\n cell: {$contacts[customer].cell}<br />\n e-mail: {$contacts[customer].email}\n</p>\n{/section}\nThe above example will output:
<p>\n name: John Smith<br />\n home: 555-555-5555<br />\n cell: 666-555-5555<br />\n e-mail: john@myexample.com\n</p>\n<p>\n name: Jack Jones<br />\n home phone: 777-555-5555<br />\n cell phone: 888-555-5555<br />\n e-mail: jack@myexample.com\n</p>\n<p>\n name: Jane Munson<br />\n home phone: 000-555-5555<br />\n cell phone: 123456<br />\n e-mail: jane@myexample.com\n</p>\nThis example assumes that $custid, $name and $address are all arrays containing the same number of values. First the php script that assign's the arrays to Smarty.
<?php\n\n$id = [1001,1002,1003];\n$smarty->assign('custid',$id);\n\n$fullnames = ['John Smith','Jack Jones','Jane Munson'];\n$smarty->assign('name',$fullnames);\n\n$addr = ['253 Abbey road', '417 Mulberry ln', '5605 apple st'];\n$smarty->assign('address',$addr);\nThe loop variable only determines the number of times to loop. You can access ANY variable from the template within the {section}. This is useful for looping multiple arrays. You can pass an array which will determine the loop count by the array size, or you can pass an integer to specify the number of loops.
{section name=customer loop=$custid}\n<p>\n id: {$custid[customer]}<br />\n name: {$name[customer]}<br />\n address: {$address[customer]}\n</p>\n{/section}\nThe above example will output:
<p>\n id: 1000<br />\n name: John Smith<br />\n address: 253 Abbey road\n</p>\n<p>\n id: 1001<br />\n name: Jack Jones<br />\n address: 417 Mulberry ln\n</p>\n<p>\n id: 1002<br />\n name: Jane Munson<br />\n address: 5605 apple st\n</p>\n{section}'s can be nested as deep as you like. With nested {section}'s, you can access complex data structures, such as multidimensional arrays. This is an example .php script that assigns the arrays.
<?php\n\n$id = [1001,1002,1003];\n$smarty->assign('custid',$id);\n\n$fullnames = ['John Smith','Jack Jones','Jane Munson'];\n$smarty->assign('name',$fullnames);\n\n$addr = ['253 N 45th', '417 Mulberry ln', '5605 apple st'];\n$smarty->assign('address',$addr);\n\n$types = [\n [ 'home phone', 'cell phone', 'e-mail'],\n [ 'home phone', 'web'],\n [ 'cell phone']\n ];\n$smarty->assign('contact_type', $types);\n\n$info = [\n ['555-555-5555', '666-555-5555', 'john@myexample.com'],\n [ '123-456-4', 'www.example.com'],\n [ '0457878']\n ];\n$smarty->assign('contact_info', $info);\nIn this template, $contact_type[customer] is an array of contact types for the current customer.
{section name=customer loop=$custid}\n<hr>\n id: {$custid[customer]}<br />\n name: {$name[customer]}<br />\n address: {$address[customer]}<br />\n {section name=contact loop=$contact_type[customer]}\n {$contact_type[customer][contact]}: {$contact_info[customer][contact]}<br />\n {/section}\n{/section}\nThe above example will output:
<hr>\n id: 1000<br />\n name: John Smith<br />\n address: 253 N 45th<br />\n home phone: 555-555-5555<br />\n cell phone: 666-555-5555<br />\n e-mail: john@myexample.com<br />\n<hr>\n id: 1001<br />\n name: Jack Jones<br />\n address: 417 Mulberry ln<br />\n home phone: 123-456-4<br />\n web: www.example.com<br />\n<hr>\n id: 1002<br />\n name: Jane Munson<br />\n address: 5605 apple st<br />\n cell phone: 0457878<br />\nResults of a database search (eg ADODB or PEAR) are assigned to Smarty
<?php\n$sql = 'select id, name, home, cell, email from contacts '\n .\"where name like '$foo%' \";\n$smarty->assign('contacts', $db->getAll($sql));\nThe template to output the database result in a HTML table
<table>\n <tr><th> </th><th>Name</th><th>Home</th><th>Cell</th><th>Email</th></tr>\n {section name=co loop=$contacts}\n <tr>\n <td><a href=\"view.php?id={$contacts[co].id}\">view</a></td>\n <td>{$contacts[co].name}</td>\n <td>{$contacts[co].home}</td>\n <td>{$contacts[co].cell}</td>\n <td>{$contacts[co].email}</td>\n <tr>\n {sectionelse}\n <tr><td colspan=\"5\">No items found</td></tr>\n {/section}\n</table>\nindex contains the current array index, starting with zero or the start attribute if given. It increments by one or by the step attribute if given.
Note
If the step and start properties are not modified, then this works the same as the iteration property, except it starts at zero instead of one.
Note
$custid[customer.index] and $custid[customer] are identical.
{section name=customer loop=$custid}\n {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\nThe above example will output:
0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nindex_prev is the previous loop index. On the first loop, this is set to -1.
index_next is the next loop index. On the last loop, this is still one more than the current index, respecting the setting of the step attribute, if given.
<?php\n $data = [1001,1002,1003,1004,1005];\n $smarty->assign('rows',$data);\nTemplate to output the above array in a table
{* $rows[row.index] and $rows[row] are identical in meaning *}\n<table>\n <tr>\n <th>index</th><th>id</th>\n <th>index_prev</th><th>prev_id</th>\n <th>index_next</th><th>next_id</th>\n </tr>\n{section name=row loop=$rows}\n <tr>\n <td>{$smarty.section.row.index}</td><td>{$rows[row]}</td>\n <td>{$smarty.section.row.index_prev}</td><td>{$rows[row.index_prev]}</td>\n <td>{$smarty.section.row.index_next}</td><td>{$rows[row.index_next]}</td>\n </tr>\n{/section}\n</table>\nThe above example will output a table containing the following:
index id index_prev prev_id index_next next_id\n 0 1001 -1 1 1002\n 1 1002 0 1001 2 1003\n 2 1003 1 1002 3 1004\n 3 1004 2 1003 4 1005\n 4 1005 3 1004 5\niteration contains the current loop iteration and starts at one.
Note
This is not affected by the {section} properties start, step and max, unlike the index property. iteration also starts with one instead of zero unlike index. rownum is an alias to iteration, they are identical.
<?php\n// array of 3000 to 3015\n$id = range(3000,3015);\n$smarty->assign('arr', $id);\nTemplate to output every other element of the $arr array as step=2
{section name=cu loop=$arr start=5 step=2}\n iteration={$smarty.section.cu.iteration}\n index={$smarty.section.cu.index}\n id={$custid[cu]}<br />\n{/section}\nThe above example will output:
iteration=1 index=5 id=3005<br />\niteration=2 index=7 id=3007<br />\niteration=3 index=9 id=3009<br />\niteration=4 index=11 id=3011<br />\niteration=5 index=13 id=3013<br />\niteration=6 index=15 id=3015<br />\nAnother example that uses the iteration property to output a table header block every five rows.
<table>\n {section name=co loop=$contacts}\n {if $smarty.section.co.iteration is div by 5}\n <tr><th> </th><th>Name</th><th>Home</th><th>Cell</th><th>Email</th></tr>\n {/if}\n <tr>\n <td><a href=\"view.php?id={$contacts[co].id}\">view<a></td>\n <td>{$contacts[co].name}</td>\n <td>{$contacts[co].home}</td>\n <td>{$contacts[co].cell}</td>\n <td>{$contacts[co].email}</td>\n <tr>\n {/section}\n</table>\nAn example that uses the index property to alternate a text color every third row.
<table>\n {section name=co loop=$contacts}\n {if $smarty.section.co.index is even by 3}\n <span style=\"color: #ffffff\">{$contacts[co].name}</span>\n {else}\n <span style=\"color: #dddddd\">{$contacts[co].name}</span>\n {/if}\n {/section}\n</table>\nNote
The \"is div by\" syntax is a simpler alternative to the PHP mod operator syntax. The mod operator is allowed: {if $smarty.section.co.iteration % 5 == 1} will work just the same.
Note
You can also use \"is odd by\" to reverse the alternating.
"},{"location":"designers/language-builtin-functions/language-function-section/#first","title":".first","text":"first is set to TRUE if the current {section} iteration is the initial one.
last is set to TRUE if the current section iteration is the final one.
This example loops the $customers array, outputs a header block on the first iteration and on the last outputs the footer block. Also uses the total property.
{section name=customer loop=$customers}\n {if $smarty.section.customer.first}\n <table>\n <tr><th>id</th><th>customer</th></tr>\n {/if}\n\n <tr>\n <td>{$customers[customer].id}}</td>\n <td>{$customers[customer].name}</td>\n </tr>\n\n {if $smarty.section.customer.last}\n <tr><td></td><td>{$smarty.section.customer.total} customers</td></tr>\n </table>\n {/if}\n{/section}\nrownum contains the current loop iteration, starting with one. It is an alias to iteration, they work identically.
loop contains the last index number that this {section} looped. This can be used inside or after the {section}.
{section name=customer loop=$custid}\n {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\nThere are {$smarty.section.customer.loop} customers shown above.\nThe above example will output:
0 id: 1000<br />\n1 id: 1001<br />\n2 id: 1002<br />\nThere are 3 customers shown above.\nshow is used as a parameter to section and is a boolean value. If FALSE, the section will not be displayed. If there is a {sectionelse} present, that will be alternately displayed.
Boolean $show_customer_info has been passed from the PHP application, to regulate whether this section shows.
{section name=customer loop=$customers show=$show_customer_info}\n {$smarty.section.customer.rownum} id: {$customers[customer]}<br />\n{/section}\n\n{if $smarty.section.customer.show}\n the section was shown.\n{else}\n the section was not shown.\n{/if}\nThe above example will output:
1 id: 1000<br />\n2 id: 1001<br />\n3 id: 1002<br />\n\nthe section was shown.\ntotal contains the number of iterations that this {section} will loop. This can be used inside or after a {section}.
{section name=customer loop=$custid step=2}\n {$smarty.section.customer.index} id: {$custid[customer]}<br />\n{/section}\n There are {$smarty.section.customer.total} customers shown above.\nSee also {foreach}, {for}, {while} and $smarty.section.
The {setfilter}...{/setfilter} block tag allows the definition of template instance's variable filters.
SYNTAX: {setfilter filter1\\|filter2\\|filter3\\....}\\...{/setfilter}
The filter can be:
A variable filter plugin specified by it's name.
A modifier specified by it's name and optional additional parameter.
{setfilter}...{/setfilter} blocks can be nested. The filter definition of inner blocks does replace the definition of the outer block.
Template instance filters run in addition to other modifiers and filters. They run in the following order: modifier, default_modifier, $escape_html, registered variable filters, autoloaded variable filters, template instance's variable filters. Everything after default_modifier can be disabled with the nofilter flag.
Note
The setting of template instance filters does not affect the output of included subtemplates.
"},{"location":"designers/language-builtin-functions/language-function-setfilter/#examples","title":"Examples","text":"<script>\n {setfilter filter1}\n {$foo} {* filter1 runs on output of $foo *}\n {setfilter filter2|mod:true}\n {$bar} {* filter2 and modifier mod runs on output of $bar *}\n {/setfilter}\n {$buh} {* filter1 runs on output of $buh *}\n {/setfilter}\n {$blar} {* no template instance filter runs on output of $blar}\n</script>\nMany times web designers run into the issue where white space and carriage returns affect the output of the rendered HTML (browser \"features\"), so you must run all your tags together in the template to get the desired results. This usually ends up in unreadable or unmanageable templates.
Anything within {strip}{/strip} tags are stripped of the extra spaces or carriage returns at the beginnings and ends of the lines before they are displayed. This way you can keep your templates readable, and not worry about extra white space causing problems.
Note
{strip}{/strip} does not affect the contents of template variables, see the strip modifier instead.
{* the following will be all run into one line upon output *}\n{strip}\n <table>\n <tr>\n <td>\n <a href=\"#\">\n This is a test\n </a>\n </td>\n </tr>\n </table>\n{/strip}\nThe above example will output:
<table><tr><td><a href=\"#\">This is a test</a></td></tr></table>\nNotice that in the above example, all the lines begin and end with HTML tags. Be aware that all the lines are run together. If you have plain text at the beginning or end of any line, they will be run together, and may not be desired results.
See also the strip modifier.
{while} loops in Smarty have much the same flexibility as PHP while statements, with a few added features for the template engine. Every {while} must be paired with a matching {/while}. All operators are recognized, such as ==, ||, or, &&, and, etc and you can use modifiers as functions, such as is_array().
{while $foo > 0}\n {$foo--}\n{/while}\nThe above example will count down the value of $foo until 1 is reached.
See also {foreach}, {for} and {section}.
Smarty comes with several custom plugin functions that you can use in the templates.
{counter} is used to print out a count. {counter} will remember the count on each iteration. You can adjust the number, the interval and the direction of the count, as well as determine whether to print the value. You can run multiple counters concurrently by supplying a unique name for each one. If you do not supply a name, the name \"default\" will be used.
If you supply the assign attribute, the output of the {counter} function will be assigned to this template variable instead of being output to the template.
{* initialize the count *}\n{counter start=0 skip=2}<br />\n{counter}<br />\n{counter}<br />\n{counter}<br />\nthis will output:
0<br />\n2<br />\n4<br />\n6<br />\n{cycle} is used to alternate a set of values. This makes it easy to for example, alternate between two or more colors in a table, or cycle through an array of values.
You can {cycle} through more than one set of values in a template by supplying a name attribute. Give each {cycle} a unique name.
You can force the current value not to print with the print attribute set to FALSE. This would be useful for silently skipping a value.
The advance attribute is used to repeat a value. When set to FALSE, the next call to {cycle} will print the same value.
If you supply the assign attribute, the output of the {cycle} function will be assigned to a template variable instead of being output to the template.
{section name=rows loop=$data}\n <tr class=\"{cycle values=\"odd,even\"}\">\n <td>{$data[rows]}</td>\n </tr>\n{/section}\nThe above template would output:
<tr class=\"odd\">\n <td>1</td>\n </tr>\n <tr class=\"even\">\n <td>2</td>\n </tr>\n <tr class=\"odd\">\n <td>3</td>\n </tr>\n{debug} dumps the debug console to the page. This works regardless of the debug settings in the php script. Since this gets executed at runtime, this is only able to show the assigned variables; not the templates that are in use. However, you can see all the currently available variables within the scope of a template.
See also the debugging console page.
"},{"location":"designers/language-custom-functions/language-function-eval/","title":"{eval}","text":"{eval} is used to evaluate a variable as a template. This can be used for things like embedding template tags/variables into variables or tags/variables into config file variables.
If you supply the assign attribute, the output of the {eval} function will be assigned to this template variable instead of being output to the template.
Note
Evaluated variables are treated the same as templates. They follow the same escapement and security features just as if they were templates.
Evaluated variables are compiled on every invocation, the compiled versions are not saved! However, if you have caching enabled, the output will be cached with the rest of the template.
If the content to evaluate doesn't change often, or is used repeatedly, consider using {include file=\"string:{$template_code}\"} instead. This may cache the compiled state and thus doesn't have to run the (comparably slow) compiler on every invocation.
The contents of the config file, setup.conf.
emphstart = <strong>\nemphend = </strong>\ntitle = Welcome to {$company}'s home page!\nErrorCity = You must supply a {#emphstart#}city{#emphend#}.\nErrorState = You must supply a {#emphstart#}state{#emphend#}.\nWhere the template is:
{config_load file='setup.conf'}\n\n{eval var=$foo}\n{eval var=#title#}\n{eval var=#ErrorCity#}\n{eval var=#ErrorState# assign='state_error'}\n{$state_error}\nThe above template will output:
This is the contents of foo.\nWelcome to Foobar Pub & Grill's home page!\nYou must supply a <strong>city</strong>.\nYou must supply a <strong>state</strong>.\nThis outputs the server name (in uppercase) and IP. The assigned variable $str could be from a database query.
<?php\n $str = 'The server name is {$smarty.server.SERVER_NAME|upper} '\n .'at {$smarty.server.SERVER_ADDR}';\n $smarty->assign('foo',$str);\nWhere the template is:
{eval var=$foo}\n{fetch} is used to retrieve files from the local file system, http, or ftp and display the contents.
If the file name begins with http://, the website page will be fetched and displayed.
Note
This will not support http redirects, be sure to include a trailing slash on your web page fetches where necessary.
If the file name begins with ftp://, the file will be downloaded from the ftp server and displayed.
For local files, either a full system file path must be given, or a path relative to the executed php script.
Note
If security is enabled, and you are fetching a file from the local file system, {fetch} will only allow files from within the $secure_dir path of the security policy. See the Security section for details.
If the assign attribute is set, the output of the {fetch} function will be assigned to this template variable instead of being output to the template.
{* include some javascript in your template *}\n{fetch file='/export/httpd/www.example.com/docs/navbar.js'}\n\n{* embed some weather text in your template from another web site *}\n{fetch file='http://www.myweather.com/68502/'}\n\n{* fetch a news headline file via ftp *}\n{fetch file='ftp://user:password@ftp.example.com/path/to/currentheadlines.txt'}\n{* as above but with variables *}\n{fetch file=\"ftp://`$user`:`$password`@`$server`/`$path`\"}\n\n{* assign the fetched contents to a template variable *}\n{fetch file='http://www.myweather.com/68502/' assign='weather'}\n{if $weather ne ''}\n <div id=\"weather\">{$weather}</div>\n{/if}\nSee also {capture}, {eval}, {assign} and fetch().
{html_checkboxes} is a custom function that creates an html checkbox group with provided data. It takes care of which item(s) are selected by default as well.
Required attributes are values and output, unless you use options instead.
All output is XHTML compliant.
All parameters that are not in the list above are printed as name/value-pairs inside each of the created <input>-tags.
<?php\n\n$smarty->assign('cust_ids', array(1000,1001,1002,1003));\n$smarty->assign('cust_names', array(\n 'Joe Schmoe',\n 'Jack Smith',\n 'Jane Johnson',\n 'Charlie Brown')\n );\n$smarty->assign('customer_id', 1001);\nwhere template is
{html_checkboxes name='id' values=$cust_ids output=$cust_names selected=$customer_id separator='<br />'}\nor where PHP code is:
<?php\n\n$smarty->assign(\n 'cust_checkboxes', \n [\n 1000 => 'Joe Schmoe',\n 1001 => 'Jack Smith',\n 1002 => 'Jane Johnson',\n 1003 => 'Charlie Brown',\n ]\n);\n$smarty->assign('customer_id', 1001);\nand the template is
{html_checkboxes name='id' options=$cust_checkboxes selected=$customer_id separator='<br />'}\nboth examples will output:
<label><input type=\"checkbox\" name=\"id[]\" value=\"1000\" />Joe Schmoe</label><br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1001\" checked=\"checked\" />Jack Smith</label>\n<br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1002\" />Jane Johnson</label><br />\n<label><input type=\"checkbox\" name=\"id[]\" value=\"1003\" />Charlie Brown</label><br />\n<?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, contact_type_id, contact '\n .'from contacts where contact_id=12';\n$smarty->assign('contact',$db->getRow($sql));\nThe results of the database queries above would be output with.
{html_checkboxes name='contact_type_id' options=$contact_types selected=$contact.contact_type_id separator='<br />'}\nSee also {html_radios} and {html_options}
{html_image} is a custom function that generates an HTML <img> tag. The height and width are automatically calculated from the image file if they are not supplied.
basedir is the base directory that relative image paths are based from. If not given, the web server's document root $_ENV['DOCUMENT_ROOT'] is used as the base. If security is enabled, then the image must be located in the $secure_dir path of the security policy. See the Security section for details.
href is the href value to link the image to. If link is supplied, an <a href=\"LINKVALUE\"><a> tag is placed around the image tag.
path_prefix is an optional prefix string you can give the output path. This is useful if you want to supply a different server name for the image.
All parameters that are not in the list above are printed as name/value-pairs inside the created <img> tag.
Note
{html_image} requires a hit to the disk to read the image and calculate the height and width. If you don't use template caching, it is generally better to avoid {html_image} and leave image tags static for optimal performance.
{html_image file='pumpkin.jpg'}\n{html_image file='/path/from/docroot/pumpkin.jpg'}\n{html_image file='../path/relative/to/currdir/pumpkin.jpg'}\nExample output of the above template would be:
<img src=\"pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n<img src=\"/path/from/docroot/pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n<img src=\"../path/relative/to/currdir/pumpkin.jpg\" alt=\"\" width=\"44\" height=\"68\" />\n{html_options} is a custom function that creates the html <select><option> group with the assigned data. It takes care of which item(s) are selected by default as well.
Required attributes are values and output, unless you use the combined options instead.
If the optional name attribute is given, the <select></select> tags are created, otherwise ONLY the <option> list is generated.
If a given value is an array, it will treat it as an html <optgroup>, and display the groups. Recursion is supported with <optgroup>.
All parameters that are not in the list above are printed as name/value-pairs inside the <select> tag. They are ignored if the optional name is not given.
All output is XHTML compliant.
<?php\n$smarty->assign('myOptions', [\n 1800 => 'Joe Schmoe',\n 9904 => 'Jack Smith',\n 2003 => 'Charlie Brown']\n );\n$smarty->assign('mySelect', 9904);\nThe following template will generate a drop-down list. Note the presence of the name attribute which creates the <select> tags.
{html_options name=foo options=$myOptions selected=$mySelect}\nOutput of the above example would be:
<select name=\"foo\">\n <option value=\"1800\">Joe Schmoe</option>\n <option value=\"9904\" selected=\"selected\">Jack Smith</option>\n <option value=\"2003\">Charlie Brown</option>\n</select> \n<?php\n$smarty->assign('cust_ids', [56,92,13]);\n$smarty->assign('cust_names', [\n 'Joe Schmoe',\n 'Jane Johnson',\n 'Charlie Brown']);\n$smarty->assign('customer_id', 92);\nThe above arrays would be output with the following template (note the use of the php count() function as a modifier to set the select size).
<select name=\"customer_id\" size=\"{$cust_names|@count}\">\n {html_options values=$cust_ids output=$cust_names selected=$customer_id}\n</select>\nThe above example would output:
<select name=\"customer_id\" size=\"3\">\n <option value=\"56\">Joe Schmoe</option>\n <option value=\"92\" selected=\"selected\">Jane Johnson</option>\n <option value=\"13\">Charlie Brown</option>\n</select>\n<?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, name, email, contact_type_id\n from contacts where contact_id='.$contact_id;\n$smarty->assign('contact',$db->getRow($sql));\nWhere a template could be as follows. Note the use of the truncate modifier.
<select name=\"type_id\">\n <option value='null'>-- none --</option>\n {html_options options=$contact_types|truncate:20 selected=$contact.type_id}\n</select>\n<?php\n$arr['Sport'] = array(6 => 'Golf', 9 => 'Cricket',7 => 'Swim');\n$arr['Rest'] = array(3 => 'Sauna',1 => 'Massage');\n$smarty->assign('lookups', $arr);\n$smarty->assign('fav', 7);\nThe script above and the following template
{html_options name=foo options=$lookups selected=$fav}\nwould output:
<select name=\"foo\">\n <optgroup label=\"Sport\">\n <option value=\"6\">Golf</option>\n <option value=\"9\">Cricket</option>\n <option value=\"7\" selected=\"selected\">Swim</option>\n </optgroup>\n <optgroup label=\"Rest\">\n <option value=\"3\">Sauna</option>\n <option value=\"1\">Massage</option>\n </optgroup>\n</select>\nSee also {html_checkboxes} and {html_radios}
{html_radios} is a custom function that creates an HTML radio button group. It also takes care of which item is selected by default as well.
Required attributes are values and output, unless you use options instead.
All output is XHTML compliant.
All parameters that are not in the list above are output as name/value-pairs inside each of the created <input>-tags.
<?php\n\n$smarty->assign('cust_ids', array(1000,1001,1002,1003));\n$smarty->assign('cust_names', array(\n 'Joe Schmoe',\n 'Jack Smith',\n 'Jane Johnson',\n 'Charlie Brown')\n );\n$smarty->assign('customer_id', 1001);\nWhere template is:
{html_radios name='id' values=$cust_ids output=$cust_names\n selected=$customer_id separator='<br />'}\n<?php\n$smarty->assign('cust_radios', array(\n 1000 => 'Joe Schmoe',\n 1001 => 'Jack Smith',\n 1002 => 'Jane Johnson',\n 1003 => 'Charlie Brown'));\n$smarty->assign('customer_id', 1001);\nWhere template is:
{html_radios name='id' options=$cust_radios\n selected=$customer_id separator='<br />'}\nBoth examples will output:
<label><input type=\"radio\" name=\"id\" value=\"1000\" />Joe Schmoe</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1001\" checked=\"checked\" />Jack Smith</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1002\" />Jane Johnson</label><br />\n<label><input type=\"radio\" name=\"id\" value=\"1003\" />Charlie Brown</label><br />\n<?php\n\n$sql = 'select type_id, types from contact_types order by type';\n$smarty->assign('contact_types',$db->getAssoc($sql));\n\n$sql = 'select contact_id, name, email, contact_type_id '\n .'from contacts where contact_id='.$contact_id;\n$smarty->assign('contact',$db->getRow($sql));\nThe variable assigned from the database above would be output with the template:
{html_radios name='contact_type_id' options=$contact_types\n selected=$contact.contact_type_id separator='<br />'}\nSee also {html_checkboxes} and {html_options}
{html_select_date} is a custom function that creates date dropdowns. It can display any or all of: year, month, and day. All parameters that are not in the list below are printed as name/value-pairs inside the <select> tags of day, month and year.
Note
There is an useful php function on the date tips page for converting {html_select_date} form values to a timestamp.
Template code
{html_select_date}\nThis will output:
<select name=\"Date_Month\">\n <option value=\"1\">January</option>\n <option value=\"2\">February</option>\n <option value=\"3\">March</option>\n ..... snipped .....\n <option value=\"10\">October</option>\n <option value=\"11\">November</option>\n <option value=\"12\" selected=\"selected\">December</option>\n</select>\n<select name=\"Date_Day\">\n <option value=\"1\">01</option>\n <option value=\"2\">02</option>\n <option value=\"3\">03</option>\n ..... snipped .....\n <option value=\"11\">11</option>\n <option value=\"12\">12</option>\n <option value=\"13\" selected=\"selected\">13</option>\n <option value=\"14\">14</option>\n <option value=\"15\">15</option>\n ..... snipped .....\n <option value=\"29\">29</option>\n <option value=\"30\">30</option>\n <option value=\"31\">31</option>\n</select>\n<select name=\"Date_Year\">\n <option value=\"2006\" selected=\"selected\">2006</option>\n</select>\n{* start and end year can be relative to current year *}\n{html_select_date prefix='StartDate' time=$time start_year='-5'\n end_year='+1' display_days=false}\nWith 2000 as the current year the output:
<select name=\"StartDateMonth\">\n <option value=\"1\">January</option>\n <option value=\"2\">February</option>\n .... snipped ....\n <option value=\"11\">November</option>\n <option value=\"12\" selected=\"selected\">December</option>\n</select>\n<select name=\"StartDateYear\">\n <option value=\"1995\">1995</option>\n .... snipped ....\n <option value=\"1999\">1999</option>\n <option value=\"2000\" selected=\"selected\">2000</option>\n <option value=\"2001\">2001</option>\n</select>\nSee also {html_select_time}, date_format, $smarty.now and the date tips page.
{html_select_time} is a custom function that creates time dropdowns for you. It can display any or all of: hour, minute, second and meridian.
The time attribute can have different formats. It can be a unique timestamp, a string of the format YYYYMMDDHHMMSS or a string that is parseable by PHP's strtotime().
strtotime(). If an array is given, the attributes field_array and prefix are used to identify the array elements to extract hour, minute, second and meridian from. display_hours TRUE Whether or not to display hours display_minutes TRUE Whether or not to display minutes display_seconds TRUE Whether or not to display seconds display_meridian TRUE Whether or not to display meridian (am/pm) use_24_hours TRUE Whether or not to use 24 hour clock minute_interval 1 Number interval in minute dropdown second_interval 1 Number interval in second dropdown hour_format \\%02d What format the hour label should be in (sprintf) hour_value_format \\%20d What format the hour value should be in (sprintf) minute_format \\%02d What format the minute label should be in (sprintf) minute_value_format \\%20d What format the minute value should be in (sprintf) second_format \\%02d What format the second label should be in (sprintf) second_value_format \\%20d What format the second value should be in (sprintf) field_array n/a Outputs values to array of this name all_extra null Adds extra attributes to select/input tags if given hour_extra null Adds extra attributes to select/input tags if given minute_extra null Adds extra attributes to select/input tags if given second_extra null Adds extra attributes to select/input tags if given meridian_extra null Adds extra attributes to select/input tags if given field_separator \\n String printed between different fields option_separator \\n String printed between different options of a field all_id null Adds id-attribute to all select/input tags if given hour_id null Adds id-attribute to select/input tags if given minute_id null Adds id-attribute to select/input tags if given second_id null Adds id-attribute to select/input tags if given meridian_id null Adds id-attribute to select/input tags if given all_empty null If supplied then the first element of any select-box has this value as it's label and \"\" as it's value. This is useful to make the select-boxes read \"Please select\" for example. hour_empty null If supplied then the first element of the hour's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an hour\" for example. minute_empty null If supplied then the first element of the minute's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an minute\" for example. second_empty null If supplied then the first element of the second's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an second\" for example. meridian_empty null If supplied then the first element of the meridian's select-box has this value as it's label and \"\" as it's value. This is useful to make the select-box read \"Please select an meridian\" for example."},{"location":"designers/language-custom-functions/language-function-html-select-time/#examples","title":"Examples","text":"{html_select_time use_24_hours=true}\nAt 9:20 and 23 seconds in the morning the template above would output:
<select name=\"Time_Hour\">\n <option value=\"00\">00</option>\n <option value=\"01\">01</option>\n ... snipped ....\n <option value=\"08\">08</option>\n <option value=\"09\" selected>09</option>\n <option value=\"10\">10</option>\n ... snipped ....\n <option value=\"22\">22</option>\n <option value=\"23\">23</option>\n</select>\n<select name=\"Time_Minute\">\n <option value=\"00\">00</option>\n <option value=\"01\">01</option>\n ... snipped ....\n <option value=\"19\">19</option>\n <option value=\"20\" selected>20</option>\n <option value=\"21\">21</option>\n ... snipped ....\n <option value=\"58\">58</option>\n <option value=\"59\">59</option>\n</select>\n<select name=\"Time_Second\">\n <option value=\"00\">00</option>\n <option value=\"01\">01</option>\n ... snipped ....\n <option value=\"22\">22</option>\n <option value=\"23\" selected>23</option>\n <option value=\"24\">24</option>\n ... snipped ....\n <option value=\"58\">58</option>\n <option value=\"59\">59</option>\n</select>\n<select name=\"Time_Meridian\">\n <option value=\"am\" selected>AM</option>\n <option value=\"pm\">PM</option>\n</select>\nSee also $smarty.now, {html_select_date} and the date tips page.
{html_table} is a custom function that dumps an array of data into an HTML <table>.
<caption> element of the table table_attr No Attributes for <table> tag (defaults to 'border=\"1\"') th_attr No Attributes for <th> tag (arrays are cycled) tr_attr No attributes for <tr> tag (arrays are cycled) td_attr No Attributes for <td> tag (arrays are cycled) trailpad No Value to pad the trailing cells on last row with (if any) (defaults to '\u00a0') hdir No Direction of each row to be rendered. possible values: right (left-to-right), and left (right-to-left) (defaults to 'right') vdir No Direction of each column to be rendered. possible values: down (top-to-bottom), up (bottom-to-top) (defaults to 'down') The cols attribute determines how many columns will be in the table.
The table_attr, tr_attr and td_attr values determine the attributes given to the <table>, <tr> and <td> tags.
If tr_attr or td_attr are arrays, they will be cycled through.
trailpad is the value put into the trailing cells on the last table row if there are any present.
<?php\n$smarty->assign( 'data', array(1,2,3,4,5,6,7,8,9) );\n$smarty->assign( 'tr', array('bgcolor=\"#eeeeee\"','bgcolor=\"#dddddd\"') );\n$smarty->display('index.tpl');\nThe variables assigned from php could be displayed as these three examples demonstrate. Each example shows the template followed by output.
** Example 1 **
{html_table loop=$data}\n<table border=\"1\">\n <tbody>\n <tr><td>1</td><td>2</td><td>3</td></tr>\n <tr><td>4</td><td>5</td><td>6</td></tr>\n <tr><td>7</td><td>8</td><td>9</td></tr>\n </tbody>\n</table>\n** Example 2 **
{html_table loop=$data cols=4 table_attr='border=\"0\"'}\n<table border=\"0\">\n <tbody>\n <tr><td>1</td><td>2</td><td>3</td><td>4</td></tr>\n <tr><td>5</td><td>6</td><td>7</td><td>8</td></tr>\n <tr><td>9</td><td> </td><td> </td><td> </td></tr>\n </tbody>\n</table>\n** Example 3 **
{html_table loop=$data cols=\"first,second,third,fourth\" tr_attr=$tr}\n<table border=\"1\">\n <thead>\n <tr>\n <th>first</th><th>second</th><th>third</th><th>fourth</th>\n </tr>\n </thead>\n <tbody>\n <tr bgcolor=\"#eeeeee\"><td>1</td><td>2</td><td>3</td><td>4</td></tr>\n <tr bgcolor=\"#dddddd\"><td>5</td><td>6</td><td>7</td><td>8</td></tr>\n <tr bgcolor=\"#eeeeee\"><td>9</td><td> </td><td> </td><td> </td></tr>\n </tbody>\n</table>\n{mailto} automates the creation of a mailto: anchor links and optionally encodes them. Encoding emails makes it more difficult for web spiders to lift email addresses off of a site.
none, hex, javascript or javascript_charcode. cc No Email addresses to carbon copy, separate entries by a comma. bcc No Email addresses to blind carbon copy, separate entries by a comma subject No Email subject newsgroups No Newsgroups to post to, separate entries by a comma. followupto No Addresses to follow up to, separate entries by a comma. extra No Any extra information you want passed to the link, such as style sheet classes Note
Javascript is probably the most thorough form of encoding, although you can use hex encoding too.
"},{"location":"designers/language-custom-functions/language-function-mailto/#examples","title":"Examples","text":"{mailto address=\"me@example.com\"}\n<a href=\"mailto:me@example.com\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" text=\"send me some mail\"}\n<a href=\"mailto:me@example.com\" >send me some mail</a>\n\n{mailto address=\"me@example.com\" encode=\"javascript\"}\n <script>\n eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b'))\n</script>\n\n{mailto address=\"me@example.com\" encode=\"hex\"}\n<a href=\"mailto:%6d%65.. snipped..3%6f%6d\">m&..snipped...#x6f;m</a>\n\n{mailto address=\"me@example.com\" subject=\"Hello to you!\"}\n<a href=\"mailto:me@example.com?subject=Hello%20to%20you%21\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" cc=\"you@example.com,they@example.com\"}\n<a href=\"mailto:me@example.com?cc=you@example.com,they@example.com\" >me@example.com</a>\n\n{mailto address=\"me@example.com\" extra='class=\"email\"'}\n<a href=\"mailto:me@example.com\" class=\"email\">me@example.com</a>\n\n{mailto address=\"me@example.com\" encode=\"javascript_charcode\"}\n <script>\n {document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))}\n</script>\nSee also escape, {textformat} and obfuscating email addresses.
{math} allows the template designer to do math equations in the template.
Any numeric template variables may be used in the equations, and the result is printed in place of the tag.
The variables used in the equation are passed as parameters, which can be template variables or static values.
+, -, /, *, abs, ceil, cos, exp, floor, log, log10, max, min, pi, pow, rand, round, sin, sqrt, srans and tan are all valid operators. Check the PHP documentation for further information on these math functions.
If you supply the assign attribute, the output of the {math} function will be assigned to this template variable instead of being output to the template.
Note
{math} is an expensive function in performance due to its use of the php eval() function. Doing the math in PHP is much more efficient, so whenever possible do the math calculations in the script and assign() the results to the template. Definitely avoid repetitive {math} function calls, eg within {section} loops.
Example 1
{* $height=4, $width=5 *}\n\n{math equation=\"x + y\" x=$height y=$width}\nThe above example will output:
9\nExample 2
{* $row_height = 10, $row_width = 20, #col_div# = 2, assigned in template *}\n\n{math equation=\"height * width / division\"\n height=$row_height\n width=$row_width\n division=#col_div#}\nThe above example will output:
100\nExample 3
{* you can use parenthesis *}\n\n{math equation=\"(( x + y ) / z )\" x=2 y=10 z=2}\nThe above example will output:
6\nExample 4
{* you can supply a format parameter in sprintf format *}\n\n{math equation=\"x + y\" x=4.4444 y=5.0000 format=\"%.2f\"}\nThe above example will output:
9.44\n{textformat} is a block tag used to format text. It basically cleans up spaces and special characters, and formats paragraphs by wrapping at a boundary and indenting lines.
You can set the parameters explicitly, or use a preset style. Currently, \"email\" is the only available style.
"},{"location":"designers/language-custom-functions/language-function-textformat/#attributes","title":"Attributes","text":"Attribute Name Default Description style n/a Preset style indent 0 The number of chars to indent every line indent_first 0 The number of chars to indent the first line indent_char (single space) The character (or string of chars) to indent with wrap 80 How many characters to wrap each line to wrap_char \\n The character (or string of chars) to break each line with wrap_cut FALSE If TRUE, wrap will break the line at the exact character instead of at a word boundary assign n/a The template variable the output will be assigned to"},{"location":"designers/language-custom-functions/language-function-textformat/#examples","title":"Examples","text":"{textformat wrap=40}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\n\n{/textformat}\nThe above example will output:
This is foo. This is foo. This is foo.\nThis is foo. This is foo. This is foo.\n\nThis is bar.\n\nbar foo bar foo foo. bar foo bar foo\nfoo. bar foo bar foo foo. bar foo bar\nfoo foo. bar foo bar foo foo. bar foo\nbar foo foo. bar foo bar foo foo.\n{textformat wrap=40 indent=4}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\n\n{/textformat}\nThe above example will output:
This is foo. This is foo. This is\n foo. This is foo. This is foo. This\n is foo.\n\n This is bar.\n\n bar foo bar foo foo. bar foo bar foo\n foo. bar foo bar foo foo. bar foo\n bar foo foo. bar foo bar foo foo.\n bar foo bar foo foo. bar foo bar\n foo foo.\n{textformat wrap=40 indent=4 indent_first=4}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\n\n{/textformat}\nThe above example will output:
This is foo. This is foo. This\n is foo. This is foo. This is foo.\n This is foo.\n\n This is bar.\n\n bar foo bar foo foo. bar foo bar\n foo foo. bar foo bar foo foo. bar\n foo bar foo foo. bar foo bar foo\n foo. bar foo bar foo foo. bar foo\n bar foo foo.\n{textformat style=\"email\"}\n\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\nThis is foo.\n\nThis is bar.\n\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\nbar foo bar foo foo.\n\n{/textformat}\nThe above example will output:
This is foo. This is foo. This is foo. This is foo. This is foo. This is\nfoo.\n\nThis is bar.\n\nbar foo bar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo\nbar foo foo. bar foo bar foo foo. bar foo bar foo foo. bar foo bar foo\nfoo.\nSee also {strip} and wordwrap.
Variable modifiers can be applied to variables, custom tags or strings. To apply a modifier, specify the value followed by a | (pipe) and the modifier name. A modifier may accept additional parameters that affect its behavior. These parameters follow the modifier name and are separated by a : (colon).
Modifiers can be applied to any type of variables, including arrays and objects.
"},{"location":"designers/language-modifiers/#examples","title":"Examples","text":"{* apply modifier to a variable *}\n{$title|upper}\n\n{* modifier with parameters *}\n{$title|truncate:40:\"...\"}\n\n{* apply modifier to a function parameter *}\n{html_table loop=$myvar|upper}\n\n{* with parameters *}\n{html_table loop=$myvar|truncate:40:\"...\"}\n\n{* apply modifier to literal string *}\n{\"foobar\"|upper}\n\n{* using date_format to format the current date *}\n{$smarty.now|date_format:\"%Y/%m/%d\"}\n\n{* apply modifier to a custom function *}\n{mailto|upper address=\"smarty@example.com\"}\n\n{* using php's str_repeat *}\n{\"=\"|str_repeat:80}\n\n{* php's count *}\n{$myArray|@count}\n\n{* this will uppercase the whole array *}\n<select name=\"name_id\">\n{html_options output=$my_array|upper}\n</select>\nYou can apply any number of modifiers to a variable. They will be applied in the order they are combined, from left to right. They must be separated with a | (pipe) character.
<?php\n\n$smarty->assign('articleTitle', 'Smokers are Productive, but Death Cuts Efficiency.');\nwhere template is:
{$articleTitle}\n{$articleTitle|upper|spacify}\n{$articleTitle|lower|spacify|truncate}\n{$articleTitle|lower|truncate:30|spacify}\n{$articleTitle|lower|spacify|truncate:30:\". . .\"}\nThe above example will output:
Smokers are Productive, but Death Cuts Efficiency.\nS M O K E R S A R ....snip.... H C U T S E F F I C I E N C Y .\ns m o k e r s a r ....snip.... b u t d e a t h c u t s...\ns m o k e r s a r e p r o d u c t i v e , b u t . . .\ns m o k e r s a r e p. . .\nModifiers can also be used in expressions. For example, you can use the isset modifier to test if a variable holds a value different from null.
{if $varA|isset}\n <b>variable A is set</b>\n{/if}\nYou can also use modifiers in expressions in a PHP-style syntax:
{if isset($varA)}\n <b>variable A is set</b>\n{/if}\nSee also registerPlugin(), combining modifiers. and extending smarty with plugins
This is used to capitalize the first letter of all words in a variable. This is similar to the PHP ucwords() function.
{$myVar|capitalize}\n<?php\n\n $smarty->assign('articleTitle', 'next x-men film, x3, delayed.');\nWhere the template is:
{$articleTitle}\n {$articleTitle|capitalize}\n {$articleTitle|capitalize:true}\nWill output:
next x-men film, x3, delayed.\n Next X-Men Film, x3, Delayed.\n Next X-Men Film, X3, Delayed.\nSee also lower and upper
This value is concatenated to the given variable.
"},{"location":"designers/language-modifiers/language-modifier-cat/#basic-usage","title":"Basic usage","text":"{$myVar|cat:' units'}\n<?php\n\n $smarty->assign('articleTitle', \"Psychics predict world didn't end\");\nWhere template is:
{$articleTitle|cat:' yesterday.'}\nWill output:
Psychics predict world didn't end yesterday.\nThis is used to count the number of characters in a variable.
"},{"location":"designers/language-modifiers/language-modifier-count-characters/#basic-usage","title":"Basic usage","text":"{$myVar|count_characters}\n<?php\n\n $smarty->assign('articleTitle', 'Cold Wave Linked to Temperatures.');\nWhere template is:
{$articleTitle}\n {$articleTitle|count_characters}\n {$articleTitle|count_characters:true}\nWill output:
Cold Wave Linked to Temperatures.\n 29\n 33\nSee also count_words, count_sentences and count_paragraphs.
This is used to count the number of paragraphs in a variable.
"},{"location":"designers/language-modifiers/language-modifier-count-paragraphs/#basic-usage","title":"Basic usage","text":"{$myVar|count_paragraphs}\n<?php\n\n $smarty->assign('articleTitle',\n \"War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\\n\\n\n Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\"\n );\nWhere template is:
{$articleTitle}\n {$articleTitle|count_paragraphs}\nWill output:
War Dims Hope for Peace. Child's Death Ruins Couple's Holiday.\n\n Man is Fatally Slain. Death Causes Loneliness, Feeling of Isolation.\n 2\nSee also count_characters, count_sentences and count_words.
This is used to count the number of sentences in a variable. A sentence being delimited by a dot, question- or exclamation-mark (.?!).
"},{"location":"designers/language-modifiers/language-modifier-count-sentences/#basic-usage","title":"Basic usage","text":"{$myVar|count_sentences}\n<?php\n\n $smarty->assign('articleTitle',\n 'Two Soviet Ships Collide - One Dies.\n Enraged Cow Injures Farmer with Axe.'\n );\nWhere template is:
{$articleTitle}\n {$articleTitle|count_sentences}\nWill output:
Two Soviet Ships Collide - One Dies. Enraged Cow Injures Farmer with Axe.\n 2\nSee also count_characters, count_paragraphs and count_words.
This is used to count the number of words in a variable.
"},{"location":"designers/language-modifiers/language-modifier-count-words/#basic-usage","title":"Basic usage","text":"{$myVar|count_words}\n<?php\n\n $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\nWhere template is:
{$articleTitle}\n {$articleTitle|count_words}\nThis will output:
Dealers Will Hear Car Talk at Noon.\n 7\nSee also count_characters, count_paragraphs and count_sentences.
Returns the number of elements in an array (or Countable object). Will return 0 for null. Returns 1 for any other type (such as a string).
If the optional mode parameter is set to 1, count() will recursively count the array. This is particularly useful for counting all the elements of a multidimensional array.
"},{"location":"designers/language-modifiers/language-modifier-count/#basic-usage","title":"Basic usage","text":"{if $myVar|count > 3}4 or more{/if}\n{if count($myVar) > 3}4 or more{/if}\nThis formats a date and time into the given strftime() format. Dates can be passed to Smarty as unix timestamps, DateTime objects, mysql timestamps or any string made up of month day year, parsable by php\\'s strtotime(). Designers can then use date_format to have complete control of the formatting of the date. If the date passed to date_format is empty and a second parameter is passed, that will be used as the date to format.
{$myVar|date_format:\"%Y-%m-%d\"}\nNote
Since Smarty-2.6.10 numeric values passed to date_format are always (except for mysql timestamps, see below) interpreted as a unix timestamp.
Before Smarty-2.6.10 numeric strings that where also parsable by strtotime() in php (like YYYYMMDD) where sometimes (depending on the underlying implementation of strtotime()) interpreted as date strings and NOT as timestamps.
The only exception are mysql timestamps: They are also numeric only and 14 characters long (YYYYMMDDHHMMSS), mysql timestamps have precedence over unix timestamps.
Note
date_format is essentially a wrapper to PHP's strftime() function. You may have more or less conversion specifiers available depending on your system's strftime() function where PHP was compiled. Check your system\\'s manpage for a full list of valid specifiers. However, a few of the specifiers are emulated on Windows. These are: %D, %e, %h, %l, %n, %r, %R, %t, %T.
<?php\n\n$config['date'] = '%I:%M %p';\n$config['time'] = '%H:%M:%S';\n$smarty->assign('config', $config);\n$smarty->assign('yesterday', strtotime('-1 day'));\nThis template uses $smarty.now to get the current time:
{$smarty.now|date_format}\n{$smarty.now|date_format:\"%D\"}\n{$smarty.now|date_format:$config.date}\n{$yesterday|date_format}\n{$yesterday|date_format:\"%A, %B %e, %Y\"}\n{$yesterday|date_format:$config.time}\nThis above will output:
Jan 1, 2022\n01/01/22\n02:33 pm\nDec 31, 2021\nMonday, December 1, 2021\n14:33:00\ndate_format conversion specifiers:
See also $smarty.now, strftime(), {html_select_date} and the date tips page.
Returns the value of the given variable in a human-readable format in HTML. Used in the debug console, but you can also use it in your template while developing to see what is going on under the hood.
Note
Use for debugging only! Since you may accidentally reveal sensitive information or introduce vulnerabilities such as XSS using this method never use it in production.
"},{"location":"designers/language-modifiers/language-modifier-debug-print-var/#basic-usage","title":"Basic usage","text":"{$myVar|debug_print_var}\nThis is used to set a default value for a variable. If the variable is unset or an empty string, the given default value is printed instead. Default takes the one argument.
"},{"location":"designers/language-modifiers/language-modifier-default/#basic-usage","title":"Basic usage","text":"{$myVar|default:\"(none)\"}\n<?php\n\n $smarty->assign('articleTitle', 'Dealers Will Hear Car Talk at Noon.');\n $smarty->assign('email', '');\nWhere template is:
{$articleTitle|default:'no title'}\n{$myTitle|default:'no title'}\n{$email|default:'No email address available'}\nWill output:
Dealers Will Hear Car Talk at Noon.\nno title\nNo email address available\nSee also the default variable handling and the blank variable handling pages.
"},{"location":"designers/language-modifiers/language-modifier-empty/","title":"empty","text":"Returns true if var does not exist or has a value that is empty or equal to zero, aka falsey, see conversion to boolean. Otherwise returns false.
"},{"location":"designers/language-modifiers/language-modifier-empty/#basic-usage","title":"Basic usage","text":"{if $myVar|empty}it's an empty variable{/if}\n{if empty($myVar)}it's an empty variable{/if}\nescape is used to encode or escape a variable to html, url, single quotes, hex, hexentity, javascript and mail. By default its html.
{$myVar|escape}\nhtml, htmlall, url, urlpathinfo, quotes, hex, hexentity, javascript, mail html This is the escape format to use. 2 string No ISO-8859-1, UTF-8, and any character set supported by htmlentities() UTF-8 The character set encoding passed to htmlentities() et. al. 3 boolean No FALSE TRUE Double encode entities from & to & (applies to html and htmlall only)"},{"location":"designers/language-modifiers/language-modifier-escape/#examples","title":"Examples","text":"<?php\n\n$smarty->assign('articleTitle',\n \"'Stiff Opposition Expected to Casketless Funeral Plan'\"\n );\n$smarty->assign('EmailAddress','smarty@example.com');\nThese are example escape template lines followed by the output
{$articleTitle}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape:'html'} {* escapes & \" ' < > *}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n{$articleTitle|escape:'htmlall'} {* escapes ALL html entities *}\n'Stiff Opposition Expected to Casketless Funeral Plan'\n\n<a href=\"?title={$articleTitle|escape:'url'}\">click here</a>\n<a\nhref=\"?title=%27Stiff%20Opposition%20Expected%20to%20Casketless%20Funeral%20Plan%27\">click here</a>\n\n{$articleTitle|escape:'quotes'}\n\\'Stiff Opposition Expected to Casketless Funeral Plan\\'\n\n<a href=\"mailto:{$EmailAddress|escape:\"hex\"}\">{$EmailAddress|escape:\"hexentity\"}</a>\n{$EmailAddress|escape:'mail'} {* this converts to email to text *}\n<a href=\"mailto:%62%6f%..snip..%65%74\">bob..snip..et</a>\n\n{'mail@example.com'|escape:'mail'}\nsmarty [AT] example [DOT] com\n\n{* the \"rewind\" parameter registers the current location *}\n<a href=\"$my_path?page=foo&rewind={$my_uri|escape:url}\">click here</a>\nThis snippet is useful for emails, but see also {mailto}
{* email address mangled *}\n<a href=\"mailto:{$EmailAddress|escape:'hex'}\">{$EmailAddress|escape:'mail'}</a>\nSee also auto-escaping, escaping smarty parsing, {mailto} and the obfuscating email addresses pages.
from_charset is used to transcode a string from a given charset to the internal charset. This is the exact opposite of the to_charset modifier.
ISO-8859-1, UTF-8, and any character set supported by mb_convert_encoding() ISO-8859-1 The charset encoding the value is supposed to be decoded from Note
Charset encoding should be handled by the application itself. This modifier should only be used in cases where the application cannot anticipate that a certain string is required in another encoding.
See also Configuring Smarty, to_charset modifier.
"},{"location":"designers/language-modifiers/language-modifier-in_array/","title":"in_array","text":"test if value is contained in an array
"},{"location":"designers/language-modifiers/language-modifier-in_array/#basic-usage","title":"Basic usage","text":"{if in_array('value2', $myarray)} value2 is in myarray{/if}\nCan be replaced by operator is in
{if 'value2' is in $myarray}value2 is in myarray{/if}\nSee Also operators
"},{"location":"designers/language-modifiers/language-modifier-indent/","title":"indent","text":"This indents a string on each line, default is 4. As an optional parameter, you can specify the number of characters to indent. As an optional second parameter, you can specify the character to use to indent with. For example: use \"\\t\" for a tab.
{$myVar|indent:4}\n<?php\n\n$smarty->assign('articleTitle',\n 'NJ judge to rule on nude beach.\nSun or rain expected today, dark tonight.\nStatistics show that teen pregnancy drops off significantly after 25.'\n );\nWhere template is:
{$articleTitle}\n\n{$articleTitle|indent}\n\n{$articleTitle|indent:10}\n\n{$articleTitle|indent:1:\"\\t\"}\nWill output:
NJ judge to rule on nude beach.\nSun or rain expected today, dark tonight.\nStatistics show that teen pregnancy drops off significantly after 25.\n\n NJ judge to rule on nude beach.\n Sun or rain expected today, dark tonight.\n Statistics show that teen pregnancy drops off significantly after 25.\n\n NJ judge to rule on nude beach.\n Sun or rain expected today, dark tonight.\n Statistics show that teen pregnancy drops off significantly after 25.\n\n NJ judge to rule on nude beach.\n Sun or rain expected today, dark tonight.\n Statistics show that teen pregnancy drops off significantly after 25.\nSee also strip, wordwrap and spacify.
Return true if the variable passed to it is an array.
"},{"location":"designers/language-modifiers/language-modifier-is_array/#basic-usage","title":"Basic usage","text":"{if $myVar|is_array}it's an array{/if}\nReturns true if the variable(s) passed to it are different from null.
If multiple parameters are supplied then isset() will return true only if all of the parameters are not null.
"},{"location":"designers/language-modifiers/language-modifier-isset/#basic-usage","title":"Basic usage","text":"{if $myVar|isset}all set!{/if}\nReturns a string containing all the element of the given array with the separator string between each.
"},{"location":"designers/language-modifiers/language-modifier-join/#basic-usage","title":"Basic usage","text":"For $myArray populated with ['a','b','c'], the following will return the string abc.
{$myArray|join}\nFor $myArray populated with [1,2,3], the following will return the string 1-2-3.
{$myArray|join:\"-\"}\nTransforms a value into a valid JSON string.
"},{"location":"designers/language-modifiers/language-modifier-json-encode/#basic-usage","title":"Basic usage","text":"{$user|json_encode}\n$user this would return a string in JSON-format, e.g. {\"username\":\"my_username\",\"email\":\"my_username@smarty.net\"}."},{"location":"designers/language-modifiers/language-modifier-json-encode/#parameters","title":"Parameters","text":"Parameter Type Required Description 1 int No bitmask of flags, directly passed to PHP's json_encode"},{"location":"designers/language-modifiers/language-modifier-json-encode/#examples","title":"Examples","text":"By passing 16 as the second parameter, you can force json_encode to always format the JSON-string as an object. Without it, an array $myArray = [\"a\",\"b\"] would be formatted as a javascript array:
{$myArray|json_encode} # renders: [\"a\",\"b\"]\n{$myArray|json_encode:16} # renders: {\"0\":\"a\",\"1\":\"b\"}\nThis is used to lowercase a variable. This is equivalent to the PHP strtolower() function.
{$myVar|lower}\n<?php\n\n$smarty->assign('articleTitle', 'Two Convicts Evade Noose, Jury Hung.');\nWhere template is:
{$articleTitle}\n{$articleTitle|lower}\nThis will output:
Two Convicts Evade Noose, Jury Hung.\ntwo convicts evade noose, jury hung.\nSee also upper and capitalize.
All \"\\n\" line breaks will be converted to html <br /> tags in the given variable. This is equivalent to the PHP\\'s nl2br() function.
{$myVar|nl2br}\n<?php\n\n$smarty->assign('articleTitle',\n \"Sun or rain expected\\ntoday, dark tonight\"\n );\nWhere the template is:
{$articleTitle|nl2br}\nWill output:
Sun or rain expected<br />today, dark tonight\nSee also word_wrap, count_paragraphs and count_sentences.
Always returns an empty string. This can be used to call a function or a method on an object that returns output, and suppress the output.
"},{"location":"designers/language-modifiers/language-modifier-noprint/#basic-usage","title":"Basic usage","text":"{$controller->sendEmail()|noprint}\nAllows you to format a number using decimals and a thousands-separator. By default, the number of decimals is 0 and the number is rounded.
"},{"location":"designers/language-modifiers/language-modifier-number-format/#basic-usage","title":"Basic usage","text":"{$num = 2000.151}\n{$num|number_format} # renders: 2,000\n{$num = 2000.151}\n{$num|number_format:2} # renders: 2,000.15\n{$num = 2000.151}\n{$num|number_format:2:\".\":\"\"} # renders: 2000.15\nPrevents variable escaping when auto-escaping is activated.
"},{"location":"designers/language-modifiers/language-modifier-raw/#basic-usage","title":"Basic usage","text":"{$myVar|raw}\nA regular expression search and replace on a variable. Use the preg_replace() syntax from the PHP manual.
{$myVar|regex_replace:\"/foo/\":\"bar\"}\nNote
Although Smarty supplies this regex convenience modifier, it is usually better to apply regular expressions in PHP, either via custom functions or modifiers. Regular expressions are considered application code and are not part of presentation logic.
"},{"location":"designers/language-modifiers/language-modifier-regex-replace/#parameters","title":"Parameters","text":"Parameter Position Type Required Description 1 string Yes This is the regular expression to be replaced. 2 string Yes This is the string of text to replace with."},{"location":"designers/language-modifiers/language-modifier-regex-replace/#examples","title":"Examples","text":"<?php\n\n$smarty->assign('articleTitle', \"Infertility unlikely to\\nbe passed on, experts say.\");\nWhere template is:
{* replace each carriage return, tab and new line with a space *}\n\n{$articleTitle}\n{$articleTitle|regex_replace:\"/[\\r\\t\\n]/\":\" \"}\nWill output:
Infertility unlikely to\nbe passed on, experts say.\nInfertility unlikely to be passed on, experts say.\nSee also replace and escape.
A simple search and replace on a variable. This is equivalent to the PHP's str_replace() function.
{$myVar|replace:\"foo\":\"bar\"}\n<?php\n\n$smarty->assign('articleTitle', \"Child's Stool Great for Use in Garden.\");\nWhere template is:
{$articleTitle}\n{$articleTitle|replace:'Garden':'Vineyard'}\n{$articleTitle|replace:' ':' '}\nWill output:
Child's Stool Great for Use in Garden.\nChild's Stool Great for Use in Vineyard.\nChild's Stool Great for Use in Garden.\nSee also regex_replace and escape.
Rounds a number to the specified precision.
"},{"location":"designers/language-modifiers/language-modifier-round/#basic-usage","title":"Basic usage","text":"{3.14|round} # renders: 3\n{3.141592|round:2} # renders: 3.14\nIf 'precision' is negative, the number is rounded to the nearest power of 10. See examples below.
The parameter 'mode' defines how the rounding is done. By default, 2.5 is rounded to 3, whereas 2.45 is rounded to 2. You usually don't need to change this. For more details on rounding modes, see PHP's documentation on round.
"},{"location":"designers/language-modifiers/language-modifier-round/#examples","title":"Examples","text":"By passing 16 as the second parameter, you can force json_encode to always format the JSON-string as an object. Without it, an array $myArray = [\"a\",\"b\"] would be formatted as a javascript array:
{$myArray|json_encode} # renders: [\"a\",\"b\"]\n{$myArray|json_encode:16} # renders: {\"0\":\"a\",\"1\":\"b\"}\nspacify is a way to insert a space between every character of a variable. You can optionally pass a different character or string to insert.
{$myVar|spacify}\n<?php\n\n$smarty->assign('articleTitle', 'Something Went Wrong in Jet Crash, Experts Say.');\nWhere template is:
{$articleTitle}\n{$articleTitle|spacify}\n{$articleTitle|spacify:\"^^\"}\nWill output:
Something Went Wrong in Jet Crash, Experts Say.\nS o m e t h i n g W .... snip .... s h , E x p e r t s S a y .\nS^^o^^m^^e^^t^^h^^i^^n^^g^^ .... snip .... ^^e^^r^^t^^s^^ ^^S^^a^^y^^.\nSee also wordwrap and nl2br.
Splits a string into an array, using the optional second parameter as the separator.
"},{"location":"designers/language-modifiers/language-modifier-split/#basic-usage","title":"Basic usage","text":"For $chars populated with 'abc', the following will produce a html list with 3 elements (a, b and c).
<ol>\n {foreach $chars|split as $char}\n <li>{$char|escape}</li>\n {/foreach}\n</ol>\nFor $ids populated with '1,2,3', the following will produce a html list with 3 elements (1, 2 and 3).
<ol>\n {foreach $ids|split:',' as $id}\n <li>{$id|escape}</li>\n {/foreach}\n</ol>\nRepeats the given value n times.
"},{"location":"designers/language-modifiers/language-modifier-str-repeat/#basic-usage","title":"Basic usage","text":"{\"hi\"|str_repeat:2} # renders: hihi\nThis is a way to format strings, such as decimal numbers and such. Use the syntax for sprintf() for the formatting.
{$myVar|string_format:\"%d\"}\n<?php\n\n$smarty->assign('number', 23.5787446);\nWhere template is:
{$number}\n{$number|string_format:\"%.2f\"}\n{$number|string_format:\"%d\"}\nWill output:
23.5787446\n23.58\n23\nSee also date_format.
This strips out HTML markup tags, basically anything between < and >.
{$myVar|strip_tags}\n<?php\n\n$smarty->assign('articleTitle',\n \"Blind Woman Gets <font face=\\\"helvetica\\\">New\nKidney</font> from Dad she Hasn't Seen in <b>years</b>.\"\n );\nWhere template is:
{$articleTitle}\n{$articleTitle|strip_tags} {* same as {$articleTitle|strip_tags:true} *}\n{$articleTitle|strip_tags:false}\nWill output:
Blind Woman Gets <font face=\"helvetica\">New Kidney</font> from Dad she Hasn't Seen in <b>years</b>.\nBlind Woman Gets New Kidney from Dad she Hasn't Seen in years .\nBlind Woman Gets New Kidney from Dad she Hasn't Seen in years.\nSee also replace and regex_replace.
This replaces all spaces, newlines and tabs with a single space, or with the supplied string.
"},{"location":"designers/language-modifiers/language-modifier-strip/#basic-usage","title":"Basic usage","text":"{$myVar|strip}\nNote
If you want to strip blocks of template text, use the built-in {strip} function.
<?php\n$smarty->assign('articleTitle', \"Grandmother of\\neight makes\\t hole in one.\");\n$smarty->display('index.tpl');\nWhere template is:
{$articleTitle}\n{$articleTitle|strip}\n{$articleTitle|strip:' '}\nWill output:
Grandmother of\neight makes hole in one.\nGrandmother of eight makes hole in one.\nGrandmother of eight makes hole in one.\nSee also {strip} and truncate.
Returns the length (number of characters) in the given string, including spaces.
"},{"location":"designers/language-modifiers/language-modifier-strlen/#basic-usage","title":"Basic usage","text":"{\"Smarty\"|strlen} # renders: 6\n{156|strlen} # renders: 3\nReturns a part (substring) of the given string starting at a given offset.
"},{"location":"designers/language-modifiers/language-modifier-substr/#basic-usage","title":"Basic usage","text":"{\"Smarty\"|substr:2} # renders: arty\n{\"Smarty\"|substr:2:3} # renders: art\nWhen used with a negative offset, the substring starts n characters from the end of the string counting backwards.
{\"Smarty\"|substr:-2} # renders: ty\n{\"Smarty\"|substr:-2:1} # renders: t\nto_charset is used to transcode a string from the internal charset to a given charset. This is the exact opposite of the from_charset modifier.
ISO-8859-1, UTF-8, and any character set supported by mb_convert_encoding() ISO-8859-1 The charset encoding the value is supposed to be encoded to Note
Charset encoding should be handled by the application itself. This modifier should only be used in cases where the application cannot anticipate that a certain string is required in another encoding.
See also Configuring Smarty, from_charset modifier.
"},{"location":"designers/language-modifiers/language-modifier-truncate/","title":"truncate","text":"This truncates a variable to a character length, the default is 80. As an optional second parameter, you can specify a string of text to display at the end if the variable was truncated. The characters in the string are included with the original truncation length. By default, truncate will attempt to cut off at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter of TRUE.
{$myVar|truncate:40:\"...\"}\n<?php\n$smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.');\nwhere template is:
{$articleTitle}\n{$articleTitle|truncate}\n{$articleTitle|truncate:30}\n{$articleTitle|truncate:30:\"\"}\n{$articleTitle|truncate:30:\"---\"}\n{$articleTitle|truncate:30:\"\":true}\n{$articleTitle|truncate:30:\"...\":true}\n{$articleTitle|truncate:30:'..':true:true}\nThis will output:
Two Sisters Reunite after Eighteen Years at Checkout Counter.\nTwo Sisters Reunite after Eighteen Years at Checkout Counter.\nTwo Sisters Reunite after...\nTwo Sisters Reunite after\nTwo Sisters Reunite after---\nTwo Sisters Reunite after Eigh\nTwo Sisters Reunite after E...\nTwo Sisters Re..ckout Counter.\nunescape is used to decode entity, html and htmlall. It counters the effects of the escape modifier for the given types.
{$myVar|unescape}\nhtml, htmlall, entity, html This is the escape format to use. 2 string No ISO-8859-1, UTF-8, and any character set supported by htmlentities() UTF-8 The character set encoding passed to html_entity_decode() or htmlspecialchars_decode() or mb_convert_encoding() et. al."},{"location":"designers/language-modifiers/language-modifier-unescape/#examples","title":"Examples","text":"<?php\n\n$smarty->assign('articleTitle',\n \"Germans use "Ümlauts" and pay in €uro\"\n );\nThese are example unescape template lines followed by the output
{$articleTitle}\nGermans use "Ümlauts" and pay in €uro\n\n{$articleTitle|unescape:\"html\"}\nGermans use \"Ümlauts\" and pay in €uro\n\n{$articleTitle|unescape:\"htmlall\"}\nGermans use \"\u00dcmlauts\" and pay in \u20acuro\nSee also escaping smarty parsing, escape modifier.
"},{"location":"designers/language-modifiers/language-modifier-upper/","title":"upper","text":"This is used to uppercase a variable. This is equivalent to the PHP strtoupper() function.
{$myVar|upper}\n<?php\n$smarty->assign('articleTitle', \"If Strike isn't Settled Quickly it may Last a While.\");\nWhere template is:
{$articleTitle}\n{$articleTitle|upper}\nWill output:
If Strike isn't Settled Quickly it may Last a While.\nIF STRIKE ISN'T SETTLED QUICKLY IT MAY LAST A WHILE.\nSee also lower and capitalize.
Wraps a string to a column width, the default is 80. As an optional second parameter, you can specify a string of text to wrap the text to the next line, the default is a carriage return \"\\n\". By default, wordwrap will attempt to wrap at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter as TRUE. This is equivalent to the PHP wordwrap() function.
{$myVar|wordwrap:30}\n<?php\n\n$smarty->assign('articleTitle',\n \"Blind woman gets new kidney from dad she hasn't seen in years.\"\n );\nWhere template is
{$articleTitle}\n\n{$articleTitle|wordwrap:30}\n\n{$articleTitle|wordwrap:20}\n\n{$articleTitle|wordwrap:30:\"<br />\\n\"}\n\n{$articleTitle|wordwrap:26:\"\\n\":true}\nWill output:
Blind woman gets new kidney from dad she hasn't seen in years.\n\nBlind woman gets new kidney\nfrom dad she hasn't seen in\nyears.\n\nBlind woman gets new\nkidney from dad she\nhasn't seen in\nyears.\n\nBlind woman gets new kidney<br />\nfrom dad she hasn't seen in<br />\nyears.\n\nBlind woman gets new kidn\ney from dad she hasn't se\nen in years.\nSee also nl2br and {textformat}.
Smarty has several types of variables. The type of the variable depends on what symbol it is prefixed or enclosed within.
Variables in Smarty can be either displayed directly or used as arguments for tags, attributes and modifiers, inside conditional expressions, etc. To print a variable, simply enclose it in the delimiters so that it is the only thing contained between them.
{$Name}\n\n{$product.part_no} <b>{$product.description}</b>\n\n{$Contacts[row].Phone}\n\n<body bgcolor=\"{#bgcolor#}\">\nYou can assign variables to specific variable scopes.
Note
An easy way to examine assigned Smarty variables is with the debugging console.
"},{"location":"designers/language-variables/language-assigned-variables/","title":"Variables assigned from PHP","text":"Variables assigned from PHP are referenced by preceding them with a dollar ($) sign.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n\n$smarty->assign('firstname', 'Doug');\n$smarty->assign('lastname', 'Evans');\n$smarty->assign('meetingPlace', 'New York');\n\n$smarty->display('index.tpl');\nindex.tpl source:
Hello {$firstname} {$lastname}, glad to see you can make it.\n<br />\n{* this will not work as $variables are case sensitive *}\nThis weeks meeting is in {$meetingplace}.\n{* this will work *}\nThis weeks meeting is in {$meetingPlace}.\nThis above would output:
Hello Doug Evans, glad to see you can make it.\n<br />\nThis weeks meeting is in .\nThis weeks meeting is in New York.\nYou can also reference associative array variables by specifying the key after a dot \".\" symbol.
<?php\n$smarty->assign('Contacts',\n array('fax' => '555-222-9876',\n 'email' => 'zaphod@slartibartfast.example.com',\n 'phone' => array('home' => '555-444-3333',\n 'cell' => '555-111-1234')\n )\n );\n$smarty->display('index.tpl');\nindex.tpl source:
{$Contacts.fax}<br />\n{$Contacts.email}<br />\n{* you can print arrays of arrays as well *}\n{$Contacts.phone.home}<br />\n{$Contacts.phone.cell}<br />\nthis will output:
555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\nYou can reference arrays by their index, much like native PHP syntax.
<?php\n$smarty->assign('Contacts', array(\n '555-222-9876',\n 'zaphod@slartibartfast.example.com',\n array('555-444-3333',\n '555-111-1234')\n ));\n$smarty->display('index.tpl');\nindex.tpl source:
{$Contacts[0]}<br />\n{$Contacts[1]}<br />\n{* you can print arrays of arrays as well *}\n{$Contacts[2][0]}<br />\n{$Contacts[2][1]}<br />\nThis will output:
555-222-9876<br />\nzaphod@slartibartfast.example.com<br />\n555-444-3333<br />\n555-111-1234<br />\nProperties of objects assigned from PHP can be referenced by specifying the property name after the -> symbol.
name: {$person->name}<br />\nemail: {$person->email}<br />\nthis will output:
name: Zaphod Beeblebrox<br />\nemail: zaphod@slartibartfast.example.com<br />\nVariables that are loaded from the config files are referenced by enclosing them within #hash_marks#, or with the smarty variable $smarty.config. The later syntax is useful for embedding into quoted attribute values, or accessing variable values such as $smarty.config.$foo.
Example config file - foo.conf:
pageTitle = \"This is mine\"\nbodyBgColor = '#eeeeee'\ntableBorderSize = 3\ntableBgColor = \"#bbbbbb\"\nrowBgColor = \"#cccccc\"\nA template demonstrating the #hash# method:
{config_load file='foo.conf'}\n<html>\n <title>{#pageTitle#}</title>\n <body bgcolor=\"{#bodyBgColor#}\">\n <table border=\"{#tableBorderSize#}\" bgcolor=\"{#tableBgColor#}\">\n <tr bgcolor=\"{#rowBgColor#}\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nA template demonstrating the $smarty.config method:
{config_load file='foo.conf'}\n<html>\n<title>{$smarty.config.pageTitle}</title>\n <body bgcolor=\"{$smarty.config.bodyBgColor}\">\n <table border=\"{$smarty.config.tableBorderSize}\" bgcolor=\"{$smarty.config.tableBgColor}\">\n <tr bgcolor=\"{$smarty.config.rowBgColor}\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nBoth examples would output:
<html>\n <title>This is mine</title>\n <body bgcolor=\"#eeeeee\">\n <table border=\"3\" bgcolor=\"#bbbbbb\">\n <tr bgcolor=\"#cccccc\">\n <td>First</td>\n <td>Last</td>\n <td>Address</td>\n </tr>\n </table>\n </body>\n</html>\nConfig file variables cannot be used until after they are loaded in from a config file. This procedure is explained later in this document under {config_load}.
See also variables and $smarty reserved variables.
"},{"location":"designers/language-variables/language-variable-scopes/","title":"Variable scopes","text":"You have the choice to assign variables to the scope of the main Smarty object, data objects created with createData(), and template objects created with createTemplate(). These objects can be chained. A template sees all the variables of its own object and all variables assigned to the objects in its chain of parent objects.
By default, templates which are rendered by $smarty->display(...) or $smarty->fetch(...) calls are automatically linked to the Smarty object variable scope.
By assigning variables to individual data or template objects you have full control which variables can be seen by a template.
<?php\n// assign variable to Smarty object scope\n$smarty->assign('foo','smarty');\n\n// assign variables to data object scope\n$data = $smarty->createData();\n$data->assign('foo','data');\n$data->assign('bar','bar-data');\n\n// assign variables to other data object scope\n$data2 = $smarty->createData($data);\n$data2->assign('bar','bar-data2');\n\n// assign variable to template object scope\n$tpl = $smarty->createTemplate('index.tpl');\n$tpl->assign('bar','bar-template');\n\n// assign variable to template object scope with link to Smarty object\n$tpl2 = $smarty->createTemplate('index.tpl',$smarty);\n$tpl2->assign('bar','bar-template2');\n\n// This display() does see $foo='smarty' from the $smarty object\n$smarty->display('index.tpl');\n\n// This display() does see $foo='data' and $bar='bar-data' from the data object $data\n$smarty->display('index.tpl',$data);\n\n// This display() does see $foo='data' from the data object $data \n// and $bar='bar-data2' from the data object $data2\n$smarty->display('index.tpl',$data2);\n\n// This display() does see $bar='bar-template' from the template object $tpl\n$tpl->display(); // or $smarty->display($tpl);\n\n// This display() does see $bar='bar-template2' from the template object $tpl2\n// and $foo='smarty' form the Smarty object $foo\n$tpl2->display(); // or $smarty->display($tpl2);\nSee also assign(), createData() and createTemplate().
The PHP reserved {$smarty} variable can be used to access several environment and request variables. The full list of them follows.
The request variables such as $_GET, $_POST, $_COOKIE, $_SERVER, $_ENV and $_SESSION can be accessed as demonstrated in the examples below:
{* display value of page from URL ($_GET) http://www.example.com/index.php?page=foo *}\n{$smarty.get.page}\n\n{* display the variable \"page\" from a form ($_POST['page']) *}\n{$smarty.post.page}\n\n{* display the value of the cookie \"username\" ($_COOKIE['username']) *}\n{$smarty.cookies.username}\n\n{* display the server variable \"SERVER_NAME\" ($_SERVER['SERVER_NAME'])*}\n{$smarty.server.SERVER_NAME}\n\n{* display the system environment variable \"PATH\" *}\n{$smarty.env.PATH}\n\n{* display the php session variable \"id\" ($_SESSION['id']) *}\n{$smarty.session.id}\n\n{* display the variable \"username\" from merged get/post/cookies/server/env *}\n{$smarty.request.username}\nNote
For historical reasons {$SCRIPT_NAME} is shorthand for {$smarty.server.SCRIPT_NAME}.
<a href=\"{$SCRIPT_NAME}?page=smarty\">click me</a>\n<a href=\"{$smarty.server.SCRIPT_NAME}?page=smarty\">click me</a>\nNote
Although Smarty provides direct access to PHP super globals for convenience, it should be used with caution. Directly accessing super globals mixes underlying application code structure with templates. A good practice is to assign specific needed values to template vars.
"},{"location":"designers/language-variables/language-variables-smarty/#smartynow","title":"{$smarty.now}","text":"The current timestamp can be accessed with {$smarty.now}. The value reflects the number of seconds passed since the so-called Epoch on January 1, 1970, and can be passed directly to the date_format modifier for display. Note that time() is called on each invocation; eg a script that takes three seconds to execute with a call to $smarty.now at start and end will show the three-second difference.
{* use the date_format modifier to show current date and time *}\n{$smarty.now|date_format:'%Y-%m-%d %H:%M:%S'}\nYou can access PHP constant values directly.
<?php\n// the constant defined in php\ndefine('MY_CONST_VAL','CHERRIES');\nOutput the constant in a template with
{$smarty.const.MY_CONST_VAL}\nNote
Although Smarty provides direct access to PHP constants for convenience, it is typically avoided as this is mixing underlying application code structure into the templates. A good practice is to assign specific needed values to template vars.
"},{"location":"designers/language-variables/language-variables-smarty/#smartycapture","title":"{$smarty.capture}","text":"Template output captured via the built-in {capture}..{/capture} function can be accessed using the {$smarty.capture} variable. See the {capture} page for more information.
{$smarty.config} variable can be used to refer to loaded config variables. {$smarty.config.foo} is a synonym for {#foo#}. See the {config_load} page for more info.
The {$smarty.section} variables can be used to refer to {section} loop properties. These have some very useful values such as .first, .index, etc.
Note
The {$smarty.foreach} variable is no longer used with the new {foreach} syntax, but is still supported with Smarty 2.x style foreach syntax.
Returns the name of the current template being processed (without the directory).
"},{"location":"designers/language-variables/language-variables-smarty/#smartytemplate_object","title":"{$smarty.template_object}","text":"Returns the template object of the current template being processed.
"},{"location":"designers/language-variables/language-variables-smarty/#smartycurrent_dir","title":"{$smarty.current_dir}","text":"Returns the name of the directory for the current template being processed if it is loaded from the filesystem (the default).
"},{"location":"designers/language-variables/language-variables-smarty/#smartyversion","title":"{$smarty.version}","text":"Returns the version of Smarty the template was compiled with.
<div id=\"footer\">Powered by Smarty {$smarty.version}</div>\nReturns block text from child template. See Template inheritance.
"},{"location":"designers/language-variables/language-variables-smarty/#smartyblockparent","title":"{$smarty.block.parent}","text":"Returns block text from parent template. See Template inheritance
"},{"location":"designers/language-variables/language-variables-smarty/#smartyldelim-smartyrdelim","title":"{$smarty.ldelim}, {$smarty.rdelim}","text":"These variables are used for printing the left-delimiter and right-delimiter value literally, the same as {ldelim},{rdelim}.
See also assigned variables and config variables
"},{"location":"programmers/api-functions/api-add-plugins-dir/","title":"Api add plugins dir","text":"addPluginsDir()
add a directory to the list of directories where plugins are stored
"},{"location":"programmers/api-functions/api-add-plugins-dir/#description","title":"Description","text":"Smarty
addPluginsDir
string|array
plugins_dir
<?php\n\n// add directory where plugins are stored\n$smarty->addPluginsDir('./plugins_1');\n\n// add multiple directories where plugins are stored\n$smarty->setPluginsDir(array(\n './plugins_2',\n './plugins_3',\n));\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// chaining of method calls\n$smarty->setPluginsDir('./plugins')\n ->addPluginsDir('./plugins_1')\n ->addPluginsDir('./plugins_2');\n\n?>\nSee also getPluginsDir(), setPluginsDir() and $plugins_dir.
append()
append an element to an assigned array
"},{"location":"programmers/api-functions/api-append/#description","title":"Description","text":"void
append
mixed
var
void
append
string
varname
mixed
var
bool
merge
If you append to a string value, it is converted to an array value and then appended to. You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs. If you pass the optional third parameter of TRUE, the value will be merged with the current array instead of appended.
NOTE.PARAMETER.MERGE
<?php\n// This is effectively the same as assign()\n$smarty->append('foo', 'Fred');\n// After this line, foo will now be seen as an array in the template\n$smarty->append('foo', 'Albert');\n\n$array = array(1 => 'one', 2 => 'two');\n$smarty->append('X', $array);\n$array2 = array(3 => 'three', 4 => 'four');\n// The following line will add a second element to the X array\n$smarty->append('X', $array2);\n\n// passing an associative array\n$smarty->append(array('city' => 'Lincoln', 'state' => 'Nebraska'));\n?>\nSee also assign() and getTemplateVars()
assign()
assign variables/objects to the templates
"},{"location":"programmers/api-functions/api-assign/#description","title":"Description","text":"void
assign
mixed
var
void
assign
string
varname
mixed
var
bool
nocache
You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs.
If you pass the optional third nocache parameter of TRUE, the variable is assigned as nocache variable. See Cacheability of Variables for details.
Note
When you assign/register objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.
<?php\n// passing name/value pairs\n$smarty->assign('Name', 'Fred');\n$smarty->assign('Address', $address);\n\n// passing an associative array\n$smarty->assign(array('city' => 'Lincoln', 'state' => 'Nebraska'));\n\n// passing an array\n$myArray = array('no' => 10, 'label' => 'Peanuts');\n$smarty->assign('foo',$myArray);\n\n// passing a row from a database (eg adodb)\n$sql = 'select id, name, email from contacts where contact ='.$id;\n$smarty->assign('contact', $db->getRow($sql));\n?>\nThese are accessed in the template with
{* note the vars are case sensitive like php *}\n{$Name}\n{$Address}\n{$city}\n{$state}\n\n{$foo.no}, {$foo.label}\n{$contact.id}, {$contact.name},{$contact.email}\nTo access more complex array assignments see {foreach} and {section}
See also getTemplateVars(), clearAssign(), append() and {assign}
clearAllAssign()
clears the values of all assigned variables
"},{"location":"programmers/api-functions/api-clear-all-assign/#description","title":"Description","text":"void
clearAllAssign
<?php\n// passing name/value pairs\n$smarty->assign('Name', 'Fred');\n$smarty->assign('Address', $address);\n\n// will output above\nprint_r( $smarty->getTemplateVars() );\n\n// clear all assigned variables\n$smarty->clearAllAssign();\n\n// will output nothing\nprint_r( $smarty->getTemplateVars() );\n\n?>\nSee also clearAssign(), clearConfig(), getTemplateVars(), assign() and append()
clearAllCache()
clears the entire template cache
"},{"location":"programmers/api-functions/api-clear-all-cache/#description","title":"Description","text":"void
clearAllCache
int
expire_time
As an optional parameter, you can supply a minimum age in seconds the cache files must be before they will get cleared.
Note
Since Smarty version 3.1.14 it is possible to delete cache files by their individual expiration time at creation by passing constant SMARTY::CLEAR_EXPIRED as expire_time parameter.
<?php\n// clear the entire cache\n$smarty->clearAllCache();\n\n// clears all files over one hour old\n$smarty->clearAllCache(3600);\n?>\nSee also clearCache(), isCached() and the caching page.
clearAssign()
clears the value of an assigned variable
"},{"location":"programmers/api-functions/api-clear-assign/#description","title":"Description","text":"void
clearAssign
mixed
var
This can be a single value, or an array of values.
<?php\n// clear a single variable\n$smarty->clearAssign('Name');\n\n// clears multiple variables\n$smarty->clearAssign(array('Name', 'Address', 'Zip'));\n?>\nSee also clearAllAssign(), clearConfig(), getTemplateVars(), assign() and append()
clearCache()
clears the cache for a specific template
"},{"location":"programmers/api-functions/api-clear-cache/#description","title":"Description","text":"void
clearCache
string
template
string
cache_id
string
compile_id
int
expire_time
If you have multiple caches for a template, you can clear a specific cache by supplying the cache_id as the second parameter.
You can also pass a $compile_id as a third parameter. You can group templates together so they can be removed as a group, see the caching section for more information.
As an optional fourth parameter, you can supply a minimum age in seconds the cache file must be before it will get cleared.
Note
Since Smarty version 3.1.14 it is possible to delete cache files by their individual expiration time at creation by passing constant SMARTY::CLEAR_EXPIRED as fourth parameter.
<?php\n// clear the cache for a template\n$smarty->clearCache('index.tpl');\n\n// clear the cache for a particular cache id in an multiple-cache template\n$smarty->clearCache('index.tpl', 'MY_CACHE_ID');\n?>\nSee also clearAllCache() and caching section.
clearCompiledTemplate()
clears the compiled version of the specified template resource
"},{"location":"programmers/api-functions/api-clear-compiled-tpl/#description","title":"Description","text":"void
clearCompiledTemplate
string
tpl_file
string
compile_id
int
exp_time
This clears the compiled version of the specified template resource, or all compiled template files if one is not specified. If you pass a $compile_id only the compiled template for this specific $compile_id is cleared. If you pass an exp_time, then only compiled templates older than exp_time seconds are cleared, by default all compiled templates are cleared regardless of their age. This function is for advanced use only, not normally needed.
<?php\n// clear a specific template resource\n$smarty->clearCompiledTemplate('index.tpl');\n\n// clear entire compile directory\n$smarty->clearCompiledTemplate();\n?>\nSee also clearCache().
clearConfig()
clears assigned config variables
"},{"location":"programmers/api-functions/api-clear-config/#description","title":"Description","text":"void
clearConfig
string
var
This clears all assigned config variables. If a variable name is supplied, only that variable is cleared.
<?php\n// clear all assigned config variables.\n$smarty->clearConfig();\n\n// clear one variable\n$smarty->clearConfig('foobar');\n?>\nSee also getConfigVars(), config variables, config files, {config_load}, configLoad() and clearAssign().
compileAllConfig()
compiles all known config files
"},{"location":"programmers/api-functions/api-compile-all-config/#description","title":"Description","text":"string
compileAllConfig
string
extension
boolean
force
integer
timelimit
integer
maxerror
This function compiles config files found in the $config_dir folder. It uses the following parameters:
extension is an optional string which defines the file extension for the config files. The default is \\\".conf\\\".
force is an optional boolean which controls if only modified (false) or all (true) config files shall be compiled. The default is \\\"false\\\".
timelimit is an optional integer to set a runtime limit in seconds for the compilation process. The default is no limit.
maxerror is an optional integer to set an error limit. If more config files failed to compile the function will be aborted. The default is no limit.
Note
This function may not create desired results in all configurations. Use is on own risk.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// force compilation of all config files\n$smarty->compileAllConfig('.config',true);\n\n?>\ncompileAllTemplates()
compiles all known templates
"},{"location":"programmers/api-functions/api-compile-all-templates/#description","title":"Description","text":"string
compileAllTemplates
string
extension
boolean
force
integer
timelimit
integer
maxerror
This function compiles template files found in the $template_dir folder. It uses the following parameters:
extension is an optional string which defines the file extension for the template files. The default is \\\".tpl\\\".
force is an optional boolean which controls if only modified (false) or all (true) templates shall be compiled. The default is \\\"false\\\".
timelimit is an optional integer to set a runtime limit in seconds for the compilation process. The default is no limit.
maxerror is an optional integer to set an error limit. If more templates failed to compile the function will be aborted. The default is no limit.
Note
This function may not create desired results in all configurations. Use is on own risk.
Note
If any template requires registered plugins, filters or objects you must register all of them before running this function.
Note
If you are using template inheritance this function will create compiled files of parent templates which will never be used.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// force compilation of all template files\n$smarty->compileAllTemplates('.tpl',true);\n\n?>\nconfigLoad()
loads config file data and assigns it to the template
"},{"location":"programmers/api-functions/api-config-load/#description","title":"Description","text":"void
configLoad
string
file
string
section
This loads config file data and assigns it to the template. This works identically to the template {config_load} function.
Note
As of Smarty 2.4.0, assigned template variables are kept across invocations of fetch() and display(). Config vars loaded from configLoad() are always global in scope. Config files are also compiled for faster execution, and respect the $force_compile and $compile_check settings.
<?php\n// load config variables and assign them\n$smarty->configLoad('my.conf');\n\n// load a section\n$smarty->configLoad('my.conf', 'foobar');\n?>\nSee also {config_load}, getConfigVars(), clearConfig(), and config variables
createData()
creates a data object
"},{"location":"programmers/api-functions/api-create-data/#description","title":"Description","text":"string
createData
object
parent
string
createData
This creates a data object which will hold assigned variables. It uses the following parameters:
parent is an optional parameter. It is an uplink to the main Smarty object, a another user-created data object or to user-created template object. These objects can be chained. Templates can access variables assigned to any of the objects in it\\'s parent chain.Data objects are used to create scopes for assigned variables. They can be used to control which variables are seen by which templates.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// create data object with its private variable scope\n$data = $smarty->createData();\n\n// assign variable to data scope\n$data->assign('foo','bar');\n\n// create template object which will use variables from data object\n$tpl = $smarty->createTemplate('index.tpl',$data);\n\n// display the template\n$tpl->display();\n?>\nSee also display(), and createTemplate(),
createTemplate()
returns a template object
"},{"location":"programmers/api-functions/api-create-template/#description","title":"Description","text":"Smarty_Internal_Template
createTemplate
string
template
object
parent
Smarty_Internal_Template
createTemplate
string
template
array
data
Smarty_Internal_Template
createTemplate
string
template
string
cache_id
string
compile_id
object
parent
Smarty_Internal_Template
createTemplate
string
template
string
cache_id
string
compile_id
array
data
This creates a template object which later can be rendered by the display or fetch method. It uses the following parameters:
template must be a valid template resource type and path.<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n// create template object with its private variable scope\n$tpl = $smarty->createTemplate('index.tpl');\n\n// assign variable to template scope\n$tpl->assign('foo','bar');\n\n// display the template\n$tpl->display();\n?>\nSee also display(), and templateExists().
disableSecurity()
disables template security
"},{"location":"programmers/api-functions/api-disable-security/#description","title":"Description","text":"string
disableSecurity
This disables security checking on templates.
See also enableSecurity(), and Security.
display()
displays the template
"},{"location":"programmers/api-functions/api-display/#description","title":"Description","text":"void
display
string
template
string
cache_id
string
compile_id
This displays the contents of a template. To return the contents of a template into a variable, use fetch(). Supply a valid template resource type and path. As an optional second parameter, you can pass a $cache_id, see the caching section for more information.
PARAMETER.COMPILEID
<?php\n\nuse Smarty\\Smarty;\n\n$smarty = new Smarty();\n$smarty->setCaching(true);\n\n// only do db calls if cache doesn't exist\nif(!$smarty->isCached('index.tpl')) {\n\n // dummy up some data\n $address = '245 N 50th';\n $db_data = array(\n 'City' => 'Lincoln',\n 'State' => 'Nebraska',\n 'Zip' => '68502'\n );\n\n $smarty->assign('Name', 'Fred');\n $smarty->assign('Address', $address);\n $smarty->assign('data', $db_data);\n\n}\n\n// display the output\n$smarty->display('index.tpl');\n?>\nUse the syntax for template resources to display files outside of the $template_dir directory.
<?php\n// absolute filepath\n$smarty->display('/usr/local/include/templates/header.tpl');\n\n// absolute filepath (same thing)\n$smarty->display('file:/usr/local/include/templates/header.tpl');\n\n// windows absolute filepath (MUST use \"file:\" prefix)\n$smarty->display('file:C:/www/pub/templates/header.tpl');\n\n// include from template resource named \"db\"\n$smarty->display('db:header.tpl');\n?>\nSee also fetch() and templateExists().
enableSecurity()
enables template security
"},{"location":"programmers/api-functions/api-enable-security/#description","title":"Description","text":"string
enableSecurity
string
securityclass
string
enableSecurity
object
securityobject
string
enableSecurity
This enables security checking on templates. It uses the following parameters:
securityclass is an optional parameter. It\\'s the name of the class with defines the security policy parameters.
securityobject is an optional parameter. It\\'s the object with defines the security policy parameters.
For the details how to setup a security policy see the Security section.
See also disableSecurity(), and Security.
fetch()
returns the template output
"},{"location":"programmers/api-functions/api-fetch/#description","title":"Description","text":"string
fetch
string
template
string
cache_id
string
compile_id
This returns the template output instead of displaying it. Supply a valid template resource type and path. As an optional second parameter, you can pass a $cache id, see the caching section for more information.
PARAMETER.COMPILEID
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty;\n\n$smarty->setCaching(true);\n\n// set a separate cache_id for each unique URL\n$cache_id = md5($_SERVER['REQUEST_URI']);\n\n// capture the output\n$output = $smarty->fetch('index.tpl', $cache_id);\n\n// do something with $output here\necho $output;\n?>\nThe email_body.tpl template
Dear {$contact_info.name},\n\nWelcome and thank you for signing up as a member of our user group.\n\nClick on the link below to login with your user name\nof '{$contact_info.username}' so you can post in our forums.\n\n{$login_url}\n\nList master\n\n{textformat wrap=40}\nThis is some long-winded disclaimer text that would automatically get wrapped\nat 40 characters. This helps make the text easier to read in mail programs that\ndo not wrap sentences for you.\n{/textformat}\nThe php script using the PHP mail() function
<?php\n\n// get $contact_info from db or other resource here\n\n$smarty->assign('contact_info',$contact_info);\n$smarty->assign('login_url',\"http://{$_SERVER['SERVER_NAME']}/login\");\n\nmail($contact_info['email'], 'Thank You', $smarty->fetch('email_body.tpl'));\n\n?>\nSee also {fetch} display(), {eval}, and templateExists().
getConfigDir()
return the directory where config files are stored
"},{"location":"programmers/api-functions/api-get-config-dir/#description","title":"Description","text":"string|array
getConfigDir
string
key
<?php\n\n// set some config directories\n$smarty->setConfigDir(array(\n 'one' => './config',\n 'two' => './config_2',\n 'three' => './config_3',\n));\n\n// get all directories where config files are stored\n$config_dir = $smarty->getConfigDir();\nvar_dump($config_dir); // array\n\n// get directory identified by key\n$config_dir = $smarty->getConfigDir('one');\nvar_dump($config_dir); // string\n\n?>\nSee also setConfigDir(), addConfigDir() and $config_dir.
getConfigVars()
returns the given loaded config variable value
"},{"location":"programmers/api-functions/api-get-config-vars/#description","title":"Description","text":"array
getConfigVars
string
varname
If no parameter is given, an array of all loaded config variables is returned.
<?php\n\n// get loaded config template var #foo#\n$myVar = $smarty->getConfigVars('foo');\n\n// get all loaded config template vars\n$all_config_vars = $smarty->getConfigVars();\n\n// take a look at them\nprint_r($all_config_vars);\n?>\nSee also clearConfig(), {config_load}, configLoad() and getTemplateVars().
getPluginsDir()
return the directory where plugins are stored
"},{"location":"programmers/api-functions/api-get-plugins-dir/#description","title":"Description","text":"array
getPluginsDir
<?php\n\n// set some plugins directories\n$smarty->setPluginsDir(array(\n './plugins',\n './plugins_2',\n));\n\n// get all directories where plugins are stored\n$config_dir = $smarty->getPluginsDir();\nvar_dump($config_dir); // array\n\n?>\nSee also setPluginsDir(), addPluginsDir() and $plugins_dir.
getRegisteredObject()
returns a reference to a registered object
"},{"location":"programmers/api-functions/api-get-registered-object/#description","title":"Description","text":"array
getRegisteredObject
string
object_name
This is useful from within a custom function when you need direct access to a registered object. See the objects page for more info.
<?php\nfunction smarty_block_foo($params, $smarty)\n{\n if (isset($params['object'])) {\n // get reference to registered object\n $obj_ref = $smarty->getRegisteredObject($params['object']);\n // use $obj_ref is now a reference to the object\n }\n}\n?>\nSee also registerObject(), unregisterObject() and objects page
getTemplateVars()
returns assigned variable value(s)
"},{"location":"programmers/api-functions/api-get-template-vars/#description","title":"Description","text":"array
getTemplateVars
string
varname
If no parameter is given, an array of all assigned variables are returned.
<?php\n// get assigned template var 'foo'\n$myVar = $smarty->getTemplateVars('foo');\n\n// get all assigned template vars\n$all_tpl_vars = $smarty->getTemplateVars();\n\n// take a look at them\nprint_r($all_tpl_vars);\n?>\nSee also assign(), {assign}, append(), clearAssign(), clearAllAssign() and getConfigVars()
isCached()
returns true if there is a valid cache for this template
"},{"location":"programmers/api-functions/api-is-cached/#description","title":"Description","text":"bool
isCached
string
template
string
cache_id
string
compile_id
This only works if $caching is set to one of \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT or \\Smarty\\Smarty::CACHING_LIFETIME_SAVED to enable caching. See the caching section for more info.
You can also pass a $cache_id as an optional second parameter in case you want multiple caches for the given template.
You can supply a $compile id as an optional third parameter. If you omit that parameter the persistent $compile_id is used if its set.
If you do not want to pass a $cache_id but want to pass a $compile_id you have to pass NULL as a $cache_id.
Note
If isCached() returns TRUE it actually loads the cached output and stores it internally. Any subsequent call to display() or fetch() will return this internally stored output and does not try to reload the cache file. This prevents a race condition that may occur when a second process clears the cache between the calls to isCached() and to display() in the example above. This also means calls to clearCache() and other changes of the cache-settings may have no effect after isCached() returned TRUE.
<?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl')) {\n// do database calls, assign vars here\n}\n\n$smarty->display('index.tpl');\n?>\n\n\n\n\n<?php\n$smarty->setCaching(Smarty::CACHING_LIFETIME_CURRENT);\n\nif(!$smarty->isCached('index.tpl', 'FrontPage')) {\n // do database calls, assign vars here\n}\n\n$smarty->display('index.tpl', 'FrontPage');\n?>\nSee also clearCache(), clearAllCache(), and caching section.
loadFilter()
load a filter plugin
"},{"location":"programmers/api-functions/api-load-filter/#description","title":"Description","text":"void
loadFilter
string
type
string
name
The first argument specifies the type of the filter to load and can be one of the following: variable, pre, post or output. The second argument specifies the name of the filter plugin.
<?php\n\n// load prefilter named 'trim'\n$smarty->loadFilter('pre', 'trim');\n\n// load another prefilter named 'datefooter'\n$smarty->loadFilter('pre', 'datefooter');\n\n// load output filter named 'compress'\n$smarty->loadFilter('output', 'compress');\n\n?>\nSee also registerFilter() and advanced features.
mutes expected warnings and notices deliberately generated by Smarty
"},{"location":"programmers/api-functions/api-mute-expected-errors/#description","title":"Description","text":"string
muteExpectedErrors
muteExpectedErrors() registers a custom error handler using set_error_handler(). The error handler merely inspects $errno and $errfile to determine if the given error was produced deliberately and must be ignored, or should be passed on to the next error handler.
\\Smarty\\Smarty::unmuteExpectedErrors() removes the current error handler. Please note, that if you\\'ve registered any custom error handlers after the muteExpectedErrors() call, the unmute will not remove Smarty\\'s muting error handler, but the one registered last.
registerCacheResource()
dynamically register CacheResources
"},{"location":"programmers/api-functions/api-register-cacheresource/#description","title":"Description","text":"void
registerCacheResource
string
name
Smarty_CacheResource
resource_handler
Use this to dynamically register a CacheResource plugin with Smarty. Pass in the name of the CacheResource and the object extending Smarty_CacheResource. See Custom Cache Implementation for more information on how to create custom CacheResources.
Note
In Smarty2 this used to be a callback function called $cache_handler_func. Smarty3 replaced this callback by the Smarty_CacheResource module.
<?php\n$smarty->registerCacheResource('mysql', new My_CacheResource_Mysql());\n?>\nSee also unregisterCacheResource() and the Custom CacheResource Implementation section.
registerClass()
register a class for use in the templates
"},{"location":"programmers/api-functions/api-register-class/#description","title":"Description","text":"void
registerClass
string
class_name
string
class_impl
Smarty allows you to access static classes from templates as long as the Security Policy does not tell it otherwise. If security is enabled, classes registered with registerClass() are accessible to templates.
<?php\nuse Smarty\\Smarty;\n\nclass Bar {\n $property = \"hello world\";\n}\n\n$smarty = new Smarty();\n$smarty->registerClass(\"Foo\", \"Bar\");\n\n\n\n\n{* Smarty will access this class as long as it's not prohibited by security *}\n{Bar::$property}\n{* Foo translates to the real class Bar *}\n{Foo::$property}\n\n\n\n\n<?php\nuse Smarty\\Smarty;\n\nnamespace my\\php\\application {\n class Bar {\n $property = \"hello world\";\n }\n}\n\n$smarty = new Smarty();\n$smarty->registerClass(\"Foo\", \"\\my\\php\\application\\Bar\");\n\n\n\n\n{* Foo translates to the real class \\my\\php\\application\\Bar *}\n{Foo::$property}\nSee also registerObject(), and Security.
registerDefaultPluginHandler()
register a function which gets called on undefined tags
"},{"location":"programmers/api-functions/api-register-default-plugin-handler/#description","title":"Description","text":"void
registerDefaultPluginHandler
mixed
callback
Register a default plugin handler which gets called if the compiler can not find a definition for a tag otherwise. It uses the following parameters:
If during compilation Smarty encounters tag which is not defined internal, registered or located in the plugins folder it tries to resolve it by calling the registered default plugin handler. The handler may be called several times for same undefined tag looping over valid plugin types.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->registerDefaultPluginHandler('my_plugin_handler');\n\n/**\n * Default Plugin Handler\n *\n * called when Smarty encounters an undefined tag during compilation\n * \n * @param string $name name of the undefined tag\n * @param string $type tag type (e.g. Smarty::PLUGIN_FUNCTION, Smarty::PLUGIN_BLOCK, \n Smarty::PLUGIN_COMPILER, Smarty::PLUGIN_MODIFIER, Smarty::PLUGIN_MODIFIERCOMPILER)\n * @param \\Smarty\\Template\\ $template template object\n * @param string &$callback returned function name \n * @param string &$script optional returned script filepath if function is external\n * @param bool &$cacheable true by default, set to false if plugin is not cachable (Smarty >= 3.1.8)\n * @return bool true if successfull\n */\nfunction my_plugin_handler ($name, $type, $template, &$callback, &$script, &$cacheable)\n{\n switch ($type) {\n case Smarty::PLUGIN_FUNCTION:\n switch ($name) {\n case 'scriptfunction':\n $script = './scripts/script_function_tag.php';\n $callback = 'default_script_function_tag';\n return true;\n case 'localfunction':\n $callback = 'default_local_function_tag';\n return true;\n default:\n return false;\n }\n case Smarty::PLUGIN_COMPILER:\n switch ($name) {\n case 'scriptcompilerfunction':\n $script = './scripts/script_compiler_function_tag.php';\n $callback = 'default_script_compiler_function_tag';\n return true;\n default:\n return false;\n }\n case Smarty::PLUGIN_BLOCK:\n switch ($name) {\n case 'scriptblock':\n $script = './scripts/script_block_tag.php';\n $callback = 'default_script_block_tag';\n return true;\n default:\n return false;\n }\n default:\n return false;\n }\n }\n\n?>\nNote
The return callback must be static; a function name or an array of class and method name.
Dynamic callbacks like objects methods are not supported.
"},{"location":"programmers/api-functions/api-register-filter/","title":"Api register filter","text":"registerFilter()
dynamically register filters
"},{"location":"programmers/api-functions/api-register-filter/#description","title":"Description","text":"void
registerFilter
string
type
mixed
callback
Use this to dynamically register filters to operate on a templates. It uses the following parameters:
NOTE.PARAMETER.FUNCTION
A prefilter runs through the template source before it gets compiled. See template prefilters for more information on how to setup a prefiltering function.
A postfilter runs through the template code after it was compiled to PHP. See template postfilters for more information on how to setup a postfiltering function.
A outputfilter operates on a template\\'s output before it is displayed. See template output filters for more information on how to set up an output filter function.
See also unregisterFilter(), loadFilter(), template pre filters template post filters template output filters section.
registerObject()
register an object for use in the templates
"},{"location":"programmers/api-functions/api-register-object/#description","title":"Description","text":"void
registerObject
string
object_name
object
object
array
allowed_methods_properties
boolean
format
array
block_methods
Note
When you register/assign objects to templates, be sure that all properties and methods accessed from the template are for presentation purposes only. It is very easy to inject application logic through objects, and this leads to poor designs that are difficult to manage. See the Best Practices section of the Smarty website.
See the objects section for more information.
See also getRegisteredObject(), and unregisterObject().
registerPlugin()
dynamically register plugins
"},{"location":"programmers/api-functions/api-register-plugin/#description","title":"Description","text":"void
registerPlugin
string
type
string
name
mixed
callback
bool
cacheable
mixed
cache_attrs
This method registers functions or methods defined in your script as plugin. It uses the following parameters:
cacheable can be omitted in most cases. See controlling cacheability of plugins output on how to use this properly.<?php\n$smarty->registerPlugin(\"function\",\"date_now\", \"print_current_date\");\n\nfunction print_current_date($params, $smarty)\n{\n if(empty($params[\"format\"])) {\n $format = \"%b %e, %Y\";\n } else {\n $format = $params[\"format\"];\n }\n return strftime($format,time());\n}\n?>\nAnd in the template
{date_now}\n\n{* or to format differently *}\n{date_now format=\"%Y/%m/%d\"}\n\n\n<?php\n// function declaration\nfunction do_translation ($params, $content, $smarty, &$repeat, $template)\n{\n if (isset($content)) {\n $lang = $params[\"lang\"];\n // do some translation with $content\n return $translation;\n }\n}\n\n// register with smarty\n$smarty->registerPlugin(\"block\",\"translate\", \"do_translation\");\n?>\nWhere the template is:
{translate lang=\"br\"}Hello, world!{/translate}\n\n\n\n\n<?php\n\n// let's map PHP's stripslashes function to a Smarty modifier.\n$smarty->registerPlugin(\"modifier\",\"ss\", \"stripslashes\");\n\n?>\nIn the template, use ss to strip slashes.
<?php\n{$var|ss}\n?>\nSee also unregisterPlugin(), plugin functions, plugin block functions, plugin compiler functions, and the creating plugin modifiers section.
registerResource()
dynamically register resources
"},{"location":"programmers/api-functions/api-register-resource/#description","title":"Description","text":"void
registerResource
string
name
Smarty_resource
resource_handler
Use this to dynamically register a Resource plugin with Smarty. Pass in the name of the Resource and the object extending Smarty_Resource. See template resources for more information on how to setup a function for fetching templates.
Note
A resource name must be at least two characters in length. One character resource names will be ignored and used as part of the file path, such as $smarty->display('c:/path/to/index.tpl');
Note
Prior to Smarty 3.1 registerResource() accepted an array of callback functions. While this is still possible for backward compatibility reasons, it is strongly discouraged as callback functions have been deprecated as of Smarty 3.1.
<?php\n$smarty->registerResource('mysql', new My_Resource_Mysql());\n?>\nSee also unregisterResource() and the template resources section.
setPluginsDir()
set the directories where plugins are stored
"},{"location":"programmers/api-functions/api-set-plugins-dir/#description","title":"Description","text":"Smarty
setPluginsDir
string|array
plugins_dir
<?php\n\n// set a single directory where the plugins are stored\n$smarty->setPluginsDir('./plugins');\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// set multiple director\u00edes where plugins are stored\n$smarty->setPluginsDir(array(\n './plugins',\n './plugins_2',\n));\n\n// view the plugins dir chain\nvar_dump($smarty->getPluginsDir());\n\n// chaining of method calls\n$smarty->setTemplateDir('./templates')\n ->setPluginsDir('./plugins')\n ->setCompileDir('./templates_c')\n ->setCacheDir('./cache');\n\n?>\nSee also getPluginsDir(), addPluginsDir() and $plugins_dir.
testInstall()
checks Smarty installation
"},{"location":"programmers/api-functions/api-test-install/#description","title":"Description","text":"void
testInstall
This function verifies that all required working folders of the Smarty installation can be accessed. It does output a corresponding protocol.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->testInstall();\n?>\nunregisterCacheResource()
dynamically unregister a CacheResource plugin
"},{"location":"programmers/api-functions/api-unregister-cacheresource/#description","title":"Description","text":"void
unregisterCacheResource
string
name
Pass in the name of the CacheResource.
<?php\n\n$smarty->unregisterCacheResource('mysql');\n\n?>\nSee also registerCacheResource() and the Custom CacheResource Implementation section.
unregisterFilter()
dynamically unregister a filter
"},{"location":"programmers/api-functions/api-unregister-filter/#description","title":"Description","text":"void
unregisterFilter
string
type
string|array
callback
Use this to dynamically unregister filters. It uses the following parameters:
See also registerFilter().
unregisterObject()
dynamically unregister an object
"},{"location":"programmers/api-functions/api-unregister-object/#description","title":"Description","text":"void
unregisterObject
string
object_name
See also registerObject() and objects section
unregisterPlugin
dynamically unregister plugins
"},{"location":"programmers/api-functions/api-unregister-plugin/#description","title":"Description","text":"void
unregisterPlugin
string
type
string
name
This method unregisters plugins which previously have been registered by registerPlugin(), It uses the following parameters:
<?php\n\n// we don't want template designers to have access to function plugin \"date_now\" \n$smarty->unregisterPlugin(\"function\",\"date_now\");\n\n?>\nSee also registerPlugin().
unregisterResource()
dynamically unregister a resource plugin
"},{"location":"programmers/api-functions/api-unregister-resource/#description","title":"Description","text":"void
unregisterResource
string
name
Pass in the name of the resource.
<?php\n\n$smarty->unregisterResource('db');\n\n?>\nSee also registerResource() and template resources
The Smarty delimiter tags { and } will be ignored so long as they are surrounded by white space. This behavior can be disabled by setting auto_literal to false.
::: {.informalexample}
<?php\n$smarty->auto_literal = false;\n?>\n:::
See also Escaping Smarty parsing,
"},{"location":"programmers/api-variables/variable-cache-dir/","title":"\\$cache_dir {#variable.cache.dir}","text":"This is the name of the directory where template caches are stored. By default this is ./cache, meaning that Smarty will look for the cache/ directory in the same directory as the executing php script. This directory must be writeable by the web server, see install for more info.
You can also use your own custom cache implementation to control cache files, which will ignore this setting. See also $use_sub_dirs.
Note
This setting must be either a relative or absolute path. include_path is not used for writing files.
Note
It is not recommended to put this directory under the web server document root.
Note
As of Smarty 3.1 the attribute \\$cache_dir is no longer accessible directly. Use getCacheDir() and setCacheDir() instead.
See also getCacheDir(), setCacheDir(), $caching, $use_sub_dirs, $cache_lifetime, $cache_modified_check and the caching section.
Persistent cache_id identifier. As an alternative to passing the same $cache_id to each and every function call, you can set this $cache_id and it will be used implicitly thereafter.
With a $cache_id you can have multiple cache files for a single call to display() or fetch() depending for example from different content of the same template. See the caching section for more information.
This is the length of time in seconds that a template cache is valid. Once this time has expired, the cache will be regenerated.
$caching must be turned on (either \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT or \\Smarty\\Smarty::CACHING_LIFETIME_SAVED) for $cache_lifetime to have any purpose.
A $cache_lifetime value of -1 will force the cache to never expire.
A value of 0 will cause the cache to always regenerate (good for testing only, to disable caching a more efficient method is to set $caching = \\Smarty\\Smarty::CACHING_OFF).
If you want to give certain templates their own cache lifetime, you could do this by setting $caching = \\Smarty\\Smarty::CACHING_LIFETIME_SAVED, then set $cache_lifetime to a unique value just before calling display() or fetch().
If $force_compile is enabled, the cache files will be regenerated every time, effectively disabling caching. You can clear all the cache files with the clear_all_cache() function, or individual cache files (or groups) with the clear_cache() function.
Cache locking avoids concurrent cache generation. This means resource intensive pages can be generated only once, even if they\\'ve been requested multiple times in the same moment.
Cache locking is disabled by default. To enable it set $cache_locking to TRUE.
See also $locking_timeout
If set to TRUE, Smarty will respect the If-Modified-Since header sent from the client. If the cached file timestamp has not changed since the last visit, then a '304: Not Modified' header will be sent instead of the content.
See also $caching, $cache_lifetime, and the caching section.
This property specifies the name of the caching handler to use. It defaults to file, enabling the internal filesystem based cache handler.
See Custom Cache Implementation for pointers on setting up your own cache handler.
"},{"location":"programmers/api-variables/variable-caching/","title":"\\$caching {#variable.caching}","text":"This tells Smarty whether or not to cache the output of the templates to the $cache_dir. By default this is set to the constant \\Smarty\\Smarty::CACHING_OFF. If your templates consistently generate the same content, it is advisable to turn on $caching, as this may result in significant performance gains.
You can also have multiple caches for the same template.
A constant value of \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT or \\Smarty\\Smarty ::CACHING_LIFETIME_SAVED enables caching.
A value of \\Smarty\\Smarty::CACHING_LIFETIME_CURRENT tells Smarty to use the current $cache_lifetime variable to determine if the cache has expired.
A value of \\Smarty\\Smarty::CACHING_LIFETIME_SAVED tells Smarty to use the $cache_lifetime value at the time the cache was generated. This way you can set the $cache_lifetime just before fetching the template to have granular control over when that particular cache expires. See also isCached().
If $compile_check is enabled, the cached content will be regenerated if any of the templates or config files that are part of this cache are changed.
If $force_compile is enabled, the cached content will always be regenerated.
See also $cache_dir, $cache_lifetime, $cache_modified_check, is_cached() and the caching section.
This is the name of the directory where compiled templates are located. By default this is ./templates_c, meaning that Smarty will look for the templates_c/ directory in the same directory as the executing php script. This directory must be writeable by the web server, see install for more info.
Note
This setting must be either a relative or absolute path. include_path is not used for writing files.
Note
It is not recommended to put this directory under the web server document root.
Note
As of Smarty 3.1 the attribute \\$compile_dir is no longer accessible directly. Use getCompileDir() and setCompileDir() instead.
See also getCompileDir(), setCompileDir(), $compile_id and $use_sub_dirs.
Persistent compile identifier. As an alternative to passing the same $compile_id to each and every function call, you can set this $compile_id and it will be used implicitly thereafter.
If you use the same template with different pre- and/or post-filters you must use a unique $compile_id to keep the compiled template files separated.
For example a prefilter that localizes your templates (that is: translates language dependent parts) at compile time, then you could use the current language as $compile_id and you will get a set of compiled templates for each language you use.
<?php\n$smarty->compile_id = 'en';\n?>\nAnother application would be to use the same compile directory across multiple domains / multiple virtual hosts.
<?php\n\n$smarty->compile_id = $_SERVER['SERVER_NAME'];\n$smarty->compile_dir = '/path/to/shared_compile_dir';\n\n?>\nNote
In Smarty 3 a $compile_id is no longer required to keep templates with same name in different $template_dir folders separated. The $template_dir file path is encoded in the file name of compiled and cached template files.
Compile locking avoids concurrent compilation of the same template.
Compile locking is enabled by default. To disable it set $compile_locking to FALSE.
Specifies the name of the compiler class that Smarty will use to compile the templates. The default is \\'Smarty_Compiler\\'. For advanced users only.
"},{"location":"programmers/api-variables/variable-config-booleanize/","title":"\\$config_booleanize {#variable.config.booleanize}","text":"If set to TRUE, config files values of on/true/yes and off/false/no get converted to boolean values automatically. This way you can use the values in the template like so: {if #foobar#}...{/if}. If foobar was on, true or yes, the {if} statement will execute. Defaults to TRUE.
This is the directory used to store config files used in the templates. Default is ./configs, meaning that Smarty will look for the configs/ directory in the same directory as the executing php script.
Note
It is not recommended to put this directory under the web server document root.
Note
As of Smarty 3.1 the attribute \\$config_dir is no longer accessible directly. Use getConfigDir(), setConfigDir() and addConfigDir() instead.
See also getConfigDir(), setConfigDir() and addConfigDir().
If set to TRUE, the default then variables read in from config files will overwrite each other. Otherwise, the variables will be pushed onto an array. This is helpful if you want to store arrays of data in config files, just list each element multiple times.
This examples uses {cycle} to output a table with alternating red/green/blue row colors with $config_overwrite = FALSE.
The config file.
# row colors\nrowColors = #FF0000\nrowColors = #00FF00\nrowColors = #0000FF\nThe template with a {section} loop.
<table>\n {section name=r loop=$rows}\n <tr bgcolor=\"{cycle values=#rowColors#}\">\n <td> ....etc.... </td>\n </tr>\n {/section}\n</table>\nSee also {config_load}, getConfigVars(), clearConfig(), configLoad() and the config files section.
If set to TRUE, hidden sections ie section names beginning with a period(.) in config files can be read from templates. Typically you would leave this FALSE, that way you can store sensitive data in the config files such as database parameters and not worry about the template loading them. FALSE by default.
"},{"location":"programmers/api-variables/variable-debug-template/","title":"\\$debug_tpl {#variable.debug_template}","text":"This is the name of the template file used for the debugging console. By default, it is named debug.tpl and is located in src/debug.tpl.
See also $debugging and the debugging console section.
This allows alternate ways to enable debugging. NONE means no alternate methods are allowed. URL means when the keyword SMARTY_DEBUG is found in the QUERY_STRING, debugging is enabled for that invocation of the script. If $debugging is TRUE, this value is ignored.
<?php\n// shows debug console only on localhost ie\n// http://localhost/script.php?foo=bar&SMARTY_DEBUG\n$smarty->debugging = false; // the default\n$smarty->debugging_ctrl = ($_SERVER['SERVER_NAME'] == 'localhost') ? 'URL' : 'NONE';\n?>\nSee also debugging console section, $debugging and $smarty_debug_id.
This enables the debugging console. The console is a javascript popup window that informs you of the included templates, variables assigned from php and config file variables for the current script. It does not show variables assigned within a template with the {assign} function.
The console can also be enabled from the url with $debugging_ctrl.
See also {debug}, $debug_tpl, and $debugging_ctrl.
This function is called when a config file cannot be obtained from its resource.
Note
The default handler is currently only invoked for file resources. It is not triggered when the resource itself cannot be found, in which case a \\Smarty\\Exception is thrown.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->default_config_handler_func = 'my_default_config_handler_func';\n\n/**\n * Default Config Handler\n *\n * called when Smarty's file: resource is unable to load a requested file\n * \n * @param string $type resource type (e.g. \"file\", \"string\", \"eval\", \"resource\")\n * @param string $name resource name (e.g. \"foo/bar.tpl\")\n * @param string &$content config's content\n * @param integer &$modified config's modification time\n * @param Smarty $smarty Smarty instance\n * @return string|boolean path to file or boolean true if $content and $modified \n * have been filled, boolean false if no default config \n * could be loaded\n */\nfunction my_default_config_handler_func($type, $name, &$content, &$modified, Smarty $smarty) {\n if (false) {\n // return corrected filepath\n return \"/tmp/some/foobar.tpl\";\n } elseif (false) {\n // return a config directly\n $content = 'someVar = \"the config source\"';\n $modified = time();\n return true;\n } else {\n // tell smarty that we failed\n return false;\n }\n}\n\n?>\nThis tells smarty what resource type to use for config files. The default value is file, meaning that $smarty->configLoad('test.conf') and $smarty->configLoad('file:test.conf') are identical in meaning. See the resource chapter for more details.
This is an array of modifiers to implicitly apply to every variable in a template. For example, to HTML-escape every variable by default, use array('escape:\"htmlall\"'). To make a variable exempt from default modifiers, add the \\'nofilter\\' attribute to the output tag such as {$var nofilter}.
This tells smarty what resource type to use implicitly. The default value is file, meaning that $smarty->display('index.tpl') and $smarty->display('file:index.tpl') are identical in meaning. See the resource chapter for more details.
This function is called when a template cannot be obtained from its resource.
Note
The default handler is currently only invoked for file resources. It is not triggered when the resource itself cannot be found, in which case a \\Smarty\\Exception is thrown.
<?php\nuse Smarty\\Smarty;\n$smarty = new Smarty();\n$smarty->default_template_handler_func = 'my_default_template_handler_func';\n\n/**\n * Default Template Handler\n *\n * called when Smarty's file: resource is unable to load a requested file\n * \n * @param string $type resource type (e.g. \"file\", \"string\", \"eval\", \"resource\")\n * @param string $name resource name (e.g. \"foo/bar.tpl\")\n * @param string &$content template's content\n * @param integer &$modified template's modification time\n * @param Smarty $smarty Smarty instance\n * @return string|boolean path to file or boolean true if $content and $modified \n * have been filled, boolean false if no default template \n * could be loaded\n */\nfunction my_default_template_handler_func($type, $name, &$content, &$modified, Smarty $smarty) {\n if (false) {\n // return corrected filepath\n return \"/tmp/some/foobar.tpl\";\n } elseif (false) {\n // return a template directly\n $content = \"the template source\";\n $modified = time();\n return true;\n } else {\n // tell smarty that we failed\n return false;\n }\n}\n\n?>\nWhen this value is set to a non-null-value it\\'s value is used as php\\'s error_reporting level inside of display() and fetch().
Smarty 3.1.2 introduced the muteExpectedErrors() function. Calling \\Smarty\\Smarty::muteExpectedErrors(); after setting up custom error handling will ensure that warnings and notices (deliberately) produced by Smarty will not be passed to other custom error handlers. If your error logs are filling up with warnings regarding filemtime() or unlink() calls, please enable Smarty\\'s error muting.
See also debugging and troubleshooting.
"},{"location":"programmers/api-variables/variable-escape-html/","title":"\\$escape_html {#variable.escape.html}","text":"Setting $escape_html to TRUE will escape all template variable output by wrapping it in htmlspecialchars({$output}, ENT_QUOTES, $char_set);, which is the same as {$variable|escape:\"html\"}.
Template designers can choose to selectively disable this feature by adding the nofilter flag: {$variable nofilter}.
Modifiers and Filters are run in the following order: modifier, default_modifier, \\$escape_html, registered variable filters, autoloaded variable filters, template instance\\'s variable filters. Everything except the individual modifier can be disabled with the nofilter flag.
Note
This is a compile time option. If you change the setting you must make sure that the templates get recompiled.
"},{"location":"programmers/api-variables/variable-force-cache/","title":"\\$force_cache {#variable.force.cache}","text":"This forces Smarty to (re)cache templates on every invocation. It does not override the $caching level, but merely pretends the template has never been cached before.
This forces Smarty to (re)compile templates on every invocation. This setting overrides $compile_check. By default this is FALSE. This is handy for development and debugging. It should never be used in a production environment. If $caching is enabled, the cache file(s) will be regenerated every time.
This is maximum time in seconds a cache lock is valid to avoid dead locks. The default value is 10 seconds.
See also $cache_locking
By setting $merge_compiled_includes to TRUE Smarty will merge the compiled template code of subtemplates into the compiled code of the main template. This increases rendering speed of templates using a many different sub-templates.
Individual sub-templates can be merged by setting the inline option flag within the {include} tag. $merge_compiled_includes does not have to be enabled for the inline merge.
::: {.informalexample}
<?php\n$smarty->merge_compiled_includes = true;\n?>\n:::
Note
This is a compile time option. If you change the setting you must make sure that the templates get recompiled.
See also {include} tag
The value of $smarty_debug_id defines the URL keyword to enable debugging at browser level. The default value is SMARTY_DEBUG.
See also debugging console section, $debugging and $debugging_ctrl.
This is the name of the default template directory. If you do not supply a resource type when including files, they will be found here. By default this is ./templates, meaning that Smarty will look for the templates/ directory in the same directory as the executing php script. \\$template_dir can also be an array of directory paths: Smarty will traverse the directories and stop on the first matching template found.
Note
It is not recommended to put this directory under the web server document root.
Note As of Smarty 3.1 the attribute \\$template_dir is no longer accessible directly. Use getTemplateDir(), setTemplateDir() and addTemplateDir() instead.
See also Template Resources, getTemplateDir(), setTemplateDir() and addTemplateDir().
Smarty will create subdirectories under the compiled templates and cache directories if $use_sub_dirs is set to TRUE, default is FALSE. In an environment where there are potentially tens of thousands of files created, this may help the filesystem speed. On the other hand, some environments do not allow PHP processes to create directories, so this must be disabled which is the default.
Sub directories are more efficient, so use them if you can. Theoretically you get much better performance on a filesystem with 10 directories each having 100 files, than with 1 directory having 1000 files. This was certainly the case with Solaris 7 (UFS)... with newer filesystems such as ext3 and especially reiserfs, the difference is almost nothing.
Note
$use_sub_dirs=true doesn\\'t work with safe_mode=On, that\\'s why it\\'s switchable and why it\\'s off by default.
$use_sub_dirs=true on Windows can cause problems.
Safe_mode is being deprecated in PHP6.
See also $compile_id, $cache_dir, and $compile_dir.