a SensioLabs Product

The flexible, fast, and secure
template engine for PHP

Functions » include

Table of Contents

Questions & Feedback

License

Twig documentation is licensed under the new BSD license.

include

New in version 1.12: The include function was added in Twig 1.12.

The include function returns the rendered content of a template:

1
2
{{ include('template.html') }}
{{ include(some_var) }}

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.

The context is passed by default to the template but you can also pass additional variables:

1
2
{# template.html will have access to the variables from the current context and the additional ones provided #}
{{ include('template.html', {foo: 'bar'}) }}

You can disable access to the context by setting with_context to false:

1
2
{# only the foo variable will be accessible #}
{{ include('template.html', {foo: 'bar'}, with_context = false) }}
1
2
{# no variables will be accessible #}
{{ include('template.html', with_context = false) }}

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));

When you set the ignore_missing flag, Twig will return an empty string if the template does not exist:

1
{{ include('sidebar.html', ignore_missing = true) }}

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

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

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

When including a template created by an end user, you should consider sandboxing it:

1
{{ include('page.html', sandboxed = true) }}

Arguments

  • template: The template to render
  • variables: The variables to pass to the template
  • with_context: Whether to pass the current context variables or not
  • ignore_missing: Whether to ignore missing templates or not
  • sandboxed: Whether to sandbox the template or not
This website is powered by PHP and Twig. The Twig logo is © 2010-2016 SensioLabs