include

Include another template. The include tag is replaced with the contents of the included template file. You can give arguments to the included template, they will be assigned as variables in the context of the included template.

Example:

{% include "_hello.tpl" name="Peter" %} world.

When _hello.tpl contains the text:

Hello {{ name }}'s

Then this will output the text Hello Peter's world..

When the template name is a string literal then the template will be inlined. When it is an expression then the template will be included during runtime.

New in version 0.9.1: Added the optional keyword.

If the included template is not required, a optional keyword may be used:

{% optional include "might-not-exist.tpl" %}

Note

About unique ids
Automatically generated ids ({{ #name }}) are unique within an included template and do not clash with similarly named ids in the including template.
With keyword

For compatibility with DTL we accept the optional with keyword betwen the template name and the arguments:

{% include "_hello.tpl" with name="Peter" %}

See also

all include and catinclude.

Caching of the included template

The output of the included template can be cached. This is useful when rendering the template takes considerable time. For example when the template shows a list of recent news items, which comprises a query, fetching and rendering a list of news items.

Caching is enabled by defining one of the caching arguments:

Argument Description Example
maxage The maximum time the output can be cached, in seconds. Specifying 0 for the maximum age does not cache the output but does protect agains slam dunks, multiple requests rendering the same template at the same time will share the output of the rendering. maxage=3600
vary Dependency keys for the cached output. If a cache key with the same name is flushed or invalidated then the cached output of this template is also invalidated. You can use category names here. vary=”news”
visible_for Sets the access control user for rendering the included template. With this you can for example force to only show public news for logged on users. Valid values are “user”, 3, “group”, 2, “community”, 1, “world”, “public”, 0 visible_for=”world”
sudo If supplied then access control is disabled whilst rendering the included template. This will show any content not visible for the current user. Use with care. sudo
runtime If supplied then the included template is not inlined but included during evaluation of the calling template. Only the supplied arguments are available as variables in the included template. runtime

New in version 0.6: Added the sudo option.

Table Of Contents

Previous topic

image_url

Next topic

inherit

Versions

Actions