PhpStorm
 
2022.3
Shortcuts: Windows
Get PhpStorm
  1. PHP frameworks and external tools
  2. Symfony
  3. Twig Templates

Twig Templates

Last modified: 01 August 2022

Besides the common templates support, the Symfony Plugin provides completion, navigation and code inspection specific to the Twig templating language.

Code completion in Twig templates

In the editor, press Ctrl+Space to invoke code completion and do any of the following:

  • Provide Templates and Blocks for appropriate functions in any TWIG file.

    Name completion in Twig template

  • Provide Extensions, Filters and Macros, both self-defined or installed from a third party.

    Extension completion in Twig template

  • Provide individual assets and full bundles.

    Asset name completion in Twig template

Code navigation in Twig templates

To navigate to the declaration of a template, block, extension, filter, macro, or asset, position the caret at its usage and press Ctrl+B. Alternatively, Ctrl+Click the usage.

Navigate to Extension in Twig template

Code inspection in Twig templates

If we refer an asset that is not known to the application (for example, if the asset does not exist yet), PhpStorm displays the corresponding warning from the Missing Asset inspection. .

Missing Twig Asset inspection

Work with Twig variables

In a Twig template, you can define variables using the {# variable_name variable_value #} syntax, for example:

{# name John #}

As soon as a variable is defined, code completion (Ctrl+Space) and navigating to declaration (Ctrl+B) for it become available.

In a similar manner, you can define a controller that uses the template by adding a controller annotation, for example:

{# @controller BloggerBlogBundle:Home:index #}

Once we do this, PhpStorm will provide code completion and navigation for all variables passed into the template.

Twig variable name completion

Language injection in Twig templates

When working with Twig templates, you can inject code fragments inside the template blocks. PhpStorm will provide you with comprehensive language assistance for editing that code fragment.

Inject JavaScript into a Twig template block automatically

PhpStorm can automatically inject code into Twig template blocks based on the defined injection rules. Out of the box, the rules for automatically injecting JavaScript code are available.

  • In a Twig template, do any of the following:

    • Add a block named javascript as follows:

      {% block javascript %}
    //injected JavaScript code
{% endblock %}

    • Add a custom script block as follows:

      {% script %}
    //injected JavaScript code
{% endscript %}

    PhpStorm will automatically inject JavaScript into the template blocks.

    https://resources.jetbrains.com/help/img/idea/2022.3/ps_twig_js_auto_injection.png
    Gif

Customize Twig syntax

In some cases it may be necessary to customize the Twig syntax. This can be useful, for example, to avoid collision with other template languages such as AngularJS.

Debug Twig templates

You can debug Twig templates using the same techniques as for regular PHP files.

Before you start, make sure that the following Twig environment options are set:

debug: true
auto_reload: true

Enable Twig debugging

  1. In the Settings dialog (Ctrl+Alt+S), go to PHP | Debug | Templates and expand the Twig Debug area.

  2. In the Cache path field, provide the absolute path to the Twig compiled templates cache folder. Type the path manually or click the Browse button and select the relevant folder in the dialog that opens. By default, compiled Twig templates are stored in the var/cache/{environment}/twig folder inside your project, where {environment} designates your configuration environment such as dev or prod.

Start a debugging session

Start a debugging session as described in the Ultimate debugging guide. The easiest and recommended approach is to use Zero-configuration debugging:

  1. Choose and install the browser extension suitable for your browser.

  2. On the PhpStorm toolbar, toggle the Start Listening for PHP Debug Connections button to start listening for incoming PHP debug connections, or choose Run | Start Listening for PHP Debug Connections from the main menu.

  3. Set a breakpoint in your code.

  4. Start the debugging session in the browser using the installed browser extension.

  5. During a debugging session, examine the program state: see variable values, evaluate expressions, step through the program, and so on.

note

See Zero-configuration debugging for the detailed step-by-step instructions, and Advanced debugging scenarios for more debugging scenarios.

During a debugging session, PhpStorm will warn you in case the template breakpoint is not reachable, which happens when a template line is not mapped to any line in a compiled PHP file.

Unreachable breakpoint in a Twig template