How to Use and Register Namespaced Twig Paths
Edit this pageWarning: You are browsing the documentation for Symfony 4.0, which is no longer maintained.
Read the updated version of this page for Symfony 6.1 (the current stable version).
How to Use and Register Namespaced Twig Paths
Usually, when you refer to a template, you'll use the relative path from the
main templates/ dir at the root of the project:
1 2 3 4 5
{# this template is located in templates/layout.html.twig #}
{% extends "layout.html.twig" %}
{# this template is located in templates/user/profile.html.twig #}
{{ include('user/profile.html.twig') }}If the application defines lots of templates and stores them in deep nested directories, you may consider using Twig namespaces, which create shortcuts to template directories.
Registering your own Namespaces
Suppose that you're using some third-party library that includes Twig templates
that live in vendor/acme/foo-bar/templates/. This path is too long, so you
can define a foo_bar Twig namespace as a shortcut.
First, register a namespace for this directory:
- YAML
- XML
- PHP
1 2 3 4 5
# config/packages/twig.yaml
twig:
# ...
paths:
'%kernel.project_dir%/vendor/acme/foo-bar/templates': foo_barThe registered namespace is called foo_bar, but you must prefix the @
character when using it in templates (that's how Twig can differentiate
namespaces from regular paths). Assuming there's a file called sidebar.twig
in the vendor/acme/foo-bar/templates/ directory, you can refer to it as:
1
{{ include('@foo_bar/sidebar.twig') }}Multiple Paths per Namespace
A single Twig namespace can be associated with multiple paths. The order in which paths are configured is very important, because Twig will always load the first template that exists, starting from the first configured path. This feature can be used as a fallback mechanism to load generic templates when the specific template doesn't exist.
- YAML
- XML
- PHP
1 2 3 4 5 6 7
# config/packages/twig.yaml
twig:
# ...
paths:
'%kernel.project_dir%/vendor/acme/themes/theme1': theme
'%kernel.project_dir%/vendor/acme/themes/theme2': theme
'%kernel.project_dir%/vendor/acme/themes/common': themeNow, you can use the same @theme namespace to refer to any template located
in the previous three directories:
1
{{ include('@theme/header.twig') }}
