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. Templating
  4. How to Inject Variables into all Templates (i.e. global Variables)
WARNING:

You are browsing the documentation for Symfony 4.0 which is not maintained anymore.

Consider upgrading your projects to Symfony 5.2.

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

4.0 version
Maintained
4.4 5.2 current 5.3 dev
Unmaintained
2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1

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 config/packages/twig.yaml file:

  • YAML
    1
2
3
4
5
    # config/packages/twig.yaml
twig:
    # ...
    globals:
        ga_tracking: UA-xxxxx-x
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <!-- config/packages/twig.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:twig="http://symfony.com/schema/dic/twig"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        http://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/twig
        http://symfony.com/schema/dic/twig/twig-1.0.xsd">

    <twig:config>
        <!-- ... -->
        <twig:global key="ga_tracking">UA-xxxxx-x</twig:global>
    </twig:config>
</container>
  • PHP
    1
2
3
4
5
6
7
    // config/packages/twig.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!

Using Service Container Parameters

You can also take advantage of the built-in Service Parameters system, which lets you isolate or reuse the value:

1
2
3
# config/services.yaml
parameters:
    ga_tracking: UA-xxxxx-x
  • YAML
    1
2
3
4
    # config/packages/twig.yaml
twig:
    globals:
        ga_tracking: '%ga_tracking%'
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    <!-- config/packages/twig.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:twig="http://symfony.com/schema/dic/twig"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        http://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/twig
        http://symfony.com/schema/dic/twig/twig-1.0.xsd">

    <twig:config>
        <twig:global key="ga_tracking">%ga_tracking%</twig:global>
    </twig:config>
</container>
  • PHP
    1
2
3
4
5
6
    // config/packages/twig.php
$container->loadFromExtension('twig', array(
     'globals' => array(
         'ga_tracking' => '%ga_tracking%',
     ),
));

The same variable is available exactly as before.

Referencing Services

Instead of using static values, you can also set the value to a service. Whenever the global variable is accessed in the template, the service will be requested from the service container and you get access to that object.

Note

The service is not loaded lazily. In other words, as soon as Twig is loaded, your service is instantiated, even if you never use that global variable.

To define a service as a global Twig variable, prefix the string with @. This should feel familiar, as it’s the same syntax you use in service configuration.

  • YAML
    1
2
3
4
5
6
    # config/packages/twig.yaml
twig:
    # ...
    globals:
        # the value is the service's id
        user_management: '@App\Service\UserManagement'
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
    <!-- config/packages/twig.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:twig="http://symfony.com/schema/dic/twig"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        http://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/twig
        http://symfony.com/schema/dic/twig/twig-1.0.xsd">

    <twig:config>
        <!-- ... -->
        <twig:global key="user_management">@App\Service\UserManagement</twig:global>
    </twig:config>
</container>
  • PHP
    1
2
3
4
5
6
7
    // config/packages/twig.php
$container->loadFromExtension('twig', array(
     // ...
     'globals' => array(
         'user_management' => '@App\Service\UserManagement',
     ),
));

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