a Sensio Labs Product

The flexible, fast, and secure
template engine for PHP

Tags » include

Questions & Feedback

License

Creative Commons License Twig documentation is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported License.

includeΒΆ

The include statement includes a template and returns the rendered content of that file into the current namespace:

1
2
3
{% include 'header.html' %}
    Body
{% include 'footer.html' %}

Included templates have access to the variables of the active context.

If you are using the filesystem loader, the templates are looked for in the paths defined by it.

You can add additional variables by passing them after the with keyword:

1
2
3
4
5
{# template.html will have access to the variables from the current context and the additional ones provided #}
{% include 'template.html' with {'foo': 'bar'} %}

{% set vars = {'foo': 'bar'} %}
{% include 'template.html' with vars %}

You can disable access to the context by appending the only keyword:

1
2
{# only the foo variable will be accessible #}
{% include 'template.html' with {'foo': 'bar'} only %}
1
2
{# no variables will be accessible #}
{% include 'template.html' only %}

Tip

When including a template created by an end user, you should consider sandboxing it. More information in the Twig for Developers chapter and in the sandbox tag documentation.

The template name can be any valid Twig expression:

1
2
{% include some_var %}
{% include ajax ? 'ajax.html' : 'not_ajax.html' %}

And if the expression evaluates to a Twig_Template object, Twig will use it directly:

1
2
3
4
5
// {% include template %}

$template = $twig->loadTemplate('some_template.twig');

$twig->loadTemplate('template.twig')->display(array('template' => $template));

New in version 1.2: The ignore missing feature has been added in Twig 1.2.

You can mark an include with ignore missing in which case Twig will ignore the statement if the template to be included does not exist. It has to be placed just after the template name. Here some valid examples:

1
2
3
{% include 'sidebar.html' ignore missing %}
{% include 'sidebar.html' ignore missing with {'foo': 'bar'} %}
{% include 'sidebar.html' ignore missing only %}

New in version 1.2: The possibility to pass an array of templates has been added in Twig 1.2.

You can also provide a list of templates that are checked for existence before inclusion. The first template that exists will be included:

1
{% include ['page_detailed.html', 'page.html'] %}

If ignore missing is given, it will fall back to rendering nothing if none of the templates exist, otherwise it will throw an exception.

This website is powered by PHP and Twig. The Twig logo is © 2010-2012 Sensio Labs