Get Smarty



Smarty Icon

You may use the Smarty logo according to the trademark notice.

Smarty Template Engine Smarty Template Engine

For sponsorship, advertising, news or other inquiries, contact us at:

Sites Using Smarty


Chapter 16. Resources

The templates may come from a variety of sources. When you display() or fetch() a template, or when you include a template from within another template, you supply a resource type, followed by the appropriate path and template name. If a resource is not explicitly given, the value of $default_resource_type (default: "file") is assumed.

File Template Resources

Smarty ships with a built-in template resource for the filesystem. The file: is the default resource. The resource key file: must only be specified, if the $default_resource_type has been changed.

If the file resource cannot find the requested template, the $default_template_handler_func is invoked.


As of Smarty 3.1 the file resource no longer walks through the include_path unless $use_include_path is activated

Templates from $template_dir

The file resource pulls templates source files from the directories specified in $template_dir. The list of directories is traversed in the order they appear in the array. The first template found is the one to process.

Example 16.1. Using templates from the $template_dir

$smarty->display('file:index.tpl'); // same as above


From within a Smarty template

{include file='index.tpl'}
{include file='file:index.tpl'} {* same as above *}


Templates from a specific $template_dir

Smarty 3.1 introduced the bracket-syntax for specifying an element from $template_dir. This allows websites employing multiple sets of templates better control over which template to acces.

The bracket-syntax can be used from anywhere you can specify the file: resource type.

Example 16.2. Specifying the $template_dir to use


// setup template directories
    './templates',            // element: 0, index: 0
    './templates_2',          // element: 1, index: 1
    '10' => 'templates_10',   // element: 2, index: '10'
    'foo' => 'templates_foo', // element: 3, index: 'foo'

  assume the template structure

// regular access
// will load ./templates/foo.tpl

// using numeric index
// will load ./templates_2/foo.tpl

// using numeric string index
// will load ./templates_10/foo.tpl

// using string index
// will load ./templates_foo/foo.tpl

// using "unknown" numeric index (using element number)
// will load ./templates_10/foo.tpl



From within a Smarty template

{include file="file:foo.tpl"}
{* will load ./templates/foo.tpl *}

{include file="file:[1]foo.tpl"}
{* will load ./templates_2/foo.tpl *}

{include file="file:[foo]foo.tpl"}
{* will load ./templates_foo/foo.tpl *}


Templates from any directory

Templates outside of the $template_dir require the file: template resource type, followed by the absolute path to the template (with leading slash.)


With Security enabled, access to templates outside of the $template_dir is not allowed unless you list those directories in $secure_dir.

Example 16.3. Using templates from any directory



And from within a Smarty template:

{include file='file:/usr/local/share/templates/navigation.tpl'}


Windows Filepaths

If you are using a Windows machine, filepaths usually include a drive letter (C:) at the beginning of the pathname. Be sure to use file: in the path to avoid namespace conflicts and get the desired results.

Example 16.4. Using templates from windows file paths



And from within Smarty template:

{include file='file:D:/usr/local/share/templates/navigation.tpl'}

No comments for this page.


Sponsors [info]