Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Cookbook
  4. Templating
  5. How to Inject Variables into all Templates (i.e. Global Variables)
WARNING: You are browsing the documentation for Symfony 2.1 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

How to Inject Variables into all Templates (i.e. Global Variables)

2.1 version
Unmaintained
2.0 2.1 2.2 2.3 2.4 2.5 2.6

How to Inject Variables into all Templates (i.e. Global Variables)

Sometimes you want a variable to be accessible to all the templates you use. This is possible inside your app/config/config.yml file:

  • YAML
    1
2
3
4
5
    # app/config/config.yml
twig:
    # ...
    globals:
        ga_tracking: UA-xxxxx-x
  • XML
    1
2
3
4
5
    <!-- app/config/config.xml -->
<twig:config ...>
    <!-- ... -->
    <twig:global key="ga_tracking">UA-xxxxx-x</twig:global>
</twig:config>
  • PHP
    1
2
3
4
5
6
7
    // app/config/config.php
$container->loadFromExtension('twig', array(
     // ...
     'globals' => array(
         'ga_tracking' => 'UA-xxxxx-x',
     ),
));

Now, the variable ga_tracking is available in all Twig templates:

1
<p>The google tracking code is: {{ ga_tracking }}</p>

It’s that easy! You can also take advantage of the built-in Service Parameters system, which lets you isolate or reuse the value:

1
2
3
# app/config/parameters.yml
parameters:
    ga_tracking: UA-xxxxx-x
  • YAML
    1
2
3
4
    # app/config/config.yml
twig:
    globals:
        ga_tracking: "%ga_tracking%"
  • XML
    1
2
3
4
    <!-- app/config/config.xml -->
<twig:config ...>
    <twig:global key="ga_tracking">%ga_tracking%</twig:global>
</twig:config>
  • PHP
    1
2
3
4
5
6
    // app/config/config.php
$container->loadFromExtension('twig', array(
     'globals' => array(
         'ga_tracking' => '%ga_tracking%',
     ),
));

The same variable is available exactly as before.

More Complex Global Variables

If the global variable you want to set is more complicated - say an object - then you won’t be able to use the above method. Instead, you’ll need to create a Twig Extension and return the global variable as one of the entries in the getGlobals method.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.