Twig

https://twig.symfony.com/doc
Admin
Twig is a flexible, fast, and secure template engine for PHP. It helps developers create dynamic web...
Tokens:89,143
Snippets:888
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Render opening form tag with form_start()

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Renders the <form> opening tag with the configured method, action, and enctype (when the form has file uploads). The example passes the 'method' option as 'GET'.

```twig
{{ form_start(form, {method: 'GET'}) }}
```

--------------------------------

### Render complete form with form()

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Renders a complete form including opening and closing tags. The example passes the 'method' option as 'GET'.

```twig
{{ form(form, {method: 'GET'}) }}
```

--------------------------------

### Install `twig/string-extra` with Composer

Source: https://twig.symfony.com/doc/3.x/filters/u.html

The `u` filter requires the `StringExtension` which is not installed by default. Install it via Composer.

```bash
$ composer require twig/string-extra
```

--------------------------------

### Install twig/intl-extra via Composer

Source: https://twig.symfony.com/doc/3.x/filters/country_name.html

Installs the IntlExtension package, which is required for the country_name filter.

```bash
$ composer require twig/intl-extra
```

--------------------------------

### Create a Twig Environment with options

Source: https://twig.symfony.com/doc/3.x/api.html

Pass an array of options as the second argument to the `\Twig\Environment` constructor. The example enables the `debug` option.

```php
$twig = new \Twig\Environment($loader, ['debug' => true]);
```

--------------------------------

### Install twig/extra-bundle on Symfony projects

Source: https://twig.symfony.com/doc/3.x/filters/country_name.html

Installs the twig/extra-bundle package for Symfony projects to enable the IntlExtension.

```bash
$ composer require twig/extra-bundle
```

--------------------------------

### Twig upper filter example

Source: https://twig.symfony.com/doc/3.x/filters/upper.html

Converts the string 'welcome' to uppercase, outputting 'WELCOME'.

```twig
{{ 'welcome'|upper }}

{# outputs 'WELCOME' #}
```

--------------------------------

### Install twig/markdown-extra via Composer

Source: https://twig.symfony.com/doc/3.x/filters/html_to_markdown.html

Installs the MarkdownExtension package, which is required for the html_to_markdown filter. This is a prerequisite for using the filter.

```bash
$ composer require twig/markdown-extra
```

--------------------------------

### Install twig/html-extra for html_attr_merge

Source: https://twig.symfony.com/doc/3.x/filters/html_attr_merge.html

Installs the HtmlExtension package, which is required for the html_attr_merge filter. Not installed by default.

```bash
$ composer require twig/html-extra
```

--------------------------------

### Example usage of a custom set tag

Source: https://twig.symfony.com/doc/3.x/advanced.html

Illustrates the intended usage of the custom set tag being defined, showing variable assignment and output.

```twig
{% set name = "value" %}

{{ name }}

{# should output value #}
```

--------------------------------

### Install Twig via Composer

Source: https://twig.symfony.com/doc/3.x/intro.html

Use Composer to install Twig 3.x. The command requires the twig/twig package with version ^3.0.

```bash
composer require "twig/twig:^3.0"
```

--------------------------------

### Basic Twig Environment Setup with FilesystemLoader

Source: https://twig.symfony.com/doc/3.x/api.html

Shows the typical way to configure Twig to load templates. Requires the autoloader, creates a FilesystemLoader pointing to the templates directory, and initializes the Environment with a cache option for compiled templates.

```php
require_once '/path/to/vendor/autoload.php';

$loader = new \Twig\Loader\FilesystemLoader('/path/to/templates');
$twig = new \Twig\Environment($loader, [
    'cache' => '/path/to/compilation_cache',
]);
```

--------------------------------

### Register an extension with addExtension()

Source: https://twig.symfony.com/doc/3.x/api.html

Shows how to register a Twig extension using the addExtension() method. The example uses the DebugExtension.

```php
$twig->addExtension(new \Twig\Extension\DebugExtension());
```

--------------------------------

### \Twig\Loader\FilesystemLoader

Source: https://twig.symfony.com/doc/3.x/api.html

Documentation for the Twig FilesystemLoader class, including constructor, methods, and usage examples.

```APIDOC
## \Twig\Loader\FilesystemLoader

### Description
Loads templates from the file system. This loader can find templates in folders on the file system and is the preferred way to load them.

### Constructor

#### `new \Twig\Loader\FilesystemLoader($paths, $rootPath = null)`

- **$paths** (string|array) - Required - A directory or an array of directories to look for templates.
- **$rootPath** (string) - Optional - The root path used for relative paths. When not passed, Twig uses `getcwd()`.

### Methods

#### `addPath($path, $namespace = 'main', $skipCheck = false)`

- **$path** (string) - Required - The directory to add.
- **$namespace** (string) - Optional - The namespace for the path. Defaults to the "main" namespace.
- **$skipCheck** (bool) - Optional - If `false` (default), throws an exception when the directory does not exist. Pass `false` to skip the check. (Added in Twig 3.31)

#### `prependPath($path, $namespace = 'main', $skipCheck = false)`

- **$path** (string) - Required - The directory to prepend.
- **$namespace** (string) - Optional - The namespace for the path. Defaults to the "main" namespace.
- **$skipCheck** (bool) - Optional - If `false` (default), throws an exception when the directory does not exist. Pass `false` to skip the check. (Added in Twig 3.31)

#### `setPaths($paths, $namespace = 'main')`

- **$paths** (array) - Required - An array of directories.
- **$namespace** (string) - Optional - The namespace for the paths.

### Usage Examples

```php
$loader = new \Twig\Loader\FilesystemLoader($templateDir);
```

```php
$loader = new \Twig\Loader\FilesystemLoader([$templateDir1, $templateDir2]);
```

```php
$loader->addPath($templateDir3);
$loader->prependPath($templateDir4);
```

```php
$loader->addPath($templateDir, 'admin');
```

```php
$twig->render('@admin/index.html.twig', []);
```

```php
$loader->addPath($templateDir, 'admin', false);
```

```php
$loader = new \Twig\Loader\FilesystemLoader('templates', getcwd().'/..');
```
```

--------------------------------

### Filter call examples with output

Source: https://twig.symfony.com/doc/3.x/advanced.html

Shows two filter usages in a template and the compiled PHP code that Twig generates for them.

```twig
{{ 'TWIG'|lower }}
{{ now|date('d/m/Y') }}
```

```php
<?php echo strtolower('TWIG') ?>
<?php echo twig_date_format_filter($now, 'd/m/Y') ?>
```

--------------------------------

### dump

Source: https://twig.symfony.com/doc/3.x/functions/dump.html

Documentation for the Twig `dump` function, including usage, arguments, and examples.

```APIDOC
## `dump` Function

### Description
Dumps information about a template variable. This is mostly useful to debug a template that does not behave as expected by introspecting its variables.

### Usage
In Twig templates, call the `dump` function with one or more variables, or with no arguments to dump all variables from the current context.

### Arguments
- **context** (mixed) - The variable(s) to dump. Can be a single variable, multiple variables, or omitted to dump all variables from the current context.

### Examples

Dump a single variable:
```twig
{{ dump(user) }}
```

Dump multiple variables:
```twig
{{ dump(user, categories) }}
```

Dump all variables from the current context:
```twig
{{ dump() }}
```

### Notes
- The `dump` function is not available by default. You must add the `\Twig\Extension\DebugExtension` extension explicitly when creating your Twig environment.
- Even when enabled, the `dump` function won't display anything if the `debug` option on the environment is not enabled (to avoid leaking debug information on a production server).
- In an HTML context, wrap the output with a `pre` tag to make it easier to read.
- Using a `pre` tag is not needed when XDebug is enabled and `html_errors` is `on`; as a bonus, the output is also nicer with XDebug enabled.
- Internally, Twig uses the PHP `var_dump` function.
```

--------------------------------

### Twig mapping test example

Source: https://twig.symfony.com/doc/3.x/tests/mapping.html

Checks if the `users` variable is a mapping and iterates over its key-value pairs if true. The example sets `users` to a mapping with string keys and values.

```twig
{% set users = {alice: "Alice Dupond", bob: "Bob Smith"} %}
{# evaluates to true if the users variable is a mapping #}
{% if users is mapping %}
    {% for key, user in users %}
        {{ key }}: {{ user }};
    {% endfor %}
{% endif %}
```

--------------------------------

### sandbox tag with for loop (won't work)

Source: https://twig.symfony.com/doc/3.x/tags/sandbox.html

Example that won't work: the sandbox tag cannot be used to sandbox a section of a template, only an include tag.

```twig
{% sandbox %}
    {% for i in 1..2 %}
        {{ i }}
    {% endfor %}
{% endsandbox %}
```

--------------------------------

### Apply html_to_markdown with options for league/html-to-markdown

Source: https://twig.symfony.com/doc/3.x/filters/html_to_markdown.html

Passes options to the html_to_markdown filter, using the hard_break option as an example for the league/html-to-markdown library.

```twig
{% apply html_to_markdown({hard_break: false}) %}
    <html>
        <h1>Hello!</h1>
    </html>
{% endapply %}
```

--------------------------------

### field_help() usage

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Returns the help text for the field. This example uses it in an aria-describedby attribute.

```twig
<input type="text" name="{{ field_name(form.slug) }}" aria-describedby="slug-help">
<small id="slug-help">{{ field_help(form.slug) }}</small>
```

--------------------------------

### format_number with options array

Source: https://twig.symfony.com/doc/3.x/filters/format_number.html

Passes an options array to tweak the output. The first example uses rounding_mode 'floor' to round down, the second sets fraction_digit to 4 to show four decimal places.

```twig
{# 12.34 #}
{{ '12.345'|format_number({rounding_mode: 'floor'}) }}

{# 1000000.0000 #}
{{ '1000000'|format_number({fraction_digit: 4}) }}
```

--------------------------------

### Context-aware filter with needs_context option

Source: https://twig.symfony.com/doc/3.x/advanced.html

Shows two filter examples: one with only 'needs_context' and one with both 'needs_context' and 'needs_environment'. The context is passed as the first argument, or second if environment is also requested.

```php
$filter = new \Twig\TwigFilter('rot13', function ($context, $string) {
    // ...
}, ['needs_context' => true]);

$filter = new \Twig\TwigFilter('rot13', function (\Twig\Environment $env, $context, $string) {
    // ...
}, ['needs_context' => true, 'needs_environment' => true]);
```

--------------------------------

### Register SandboxBridgeExtension and SandboxBridgeRuntime

Source: https://twig.symfony.com/doc/3.x/functions/render_sandboxed.html

Registers the required extension and runtime loader to enable the `render_sandboxed` function. The function is not available by default; this setup is necessary on the trusted environment.

```php
use Twig\Extension\SandboxBridgeExtension;
use Twig\Runtime\SandboxBridgeRuntime;
use Twig\RuntimeLoader\FactoryRuntimeLoader;

$twig->addExtension(new SandboxBridgeExtension());
$twig->addRuntimeLoader(new FactoryRuntimeLoader([
    SandboxBridgeRuntime::class => fn () => new SandboxBridgeRuntime(
        $sandbox,
    ),
]));
```

--------------------------------

### Multiple branches with elseif and else

Source: https://twig.symfony.com/doc/3.x/tags/if.html

Uses `elseif` and `else` for multiple branches, similar to PHP. The example shows different messages based on stock levels.

```twig
{% if product.stock > 10 %}
   Available
{% elseif product.stock > 0 %}
   Only {{ product.stock }} left!
{% else %}
   Sold-out!
{% endif %}
```

--------------------------------

### Render a namespaced template

Source: https://twig.symfony.com/doc/3.x/api.html

Renders a template using the @namespace/template notation. This example renders the 'index.html.twig' template from the 'admin' namespace.

```php
$twig->render('@admin/index.html.twig', []);
```

--------------------------------

### Basic include tag usage

Source: https://twig.symfony.com/doc/3.x/tags/include.html

Includes a template and outputs its rendered content. The example shows including header and footer templates around body content.

```twig
{% include 'header.html.twig' %}
    Body
{% include 'footer.html.twig' %}
```

--------------------------------

### Register runtime loader for non-static methods

Source: https://twig.symfony.com/doc/3.x/advanced.html

When methods are not static, register the class as a runtime extension using a runtime loader. The example shows a class with a constructor dependency and a FactoryRuntimeLoader that instantiates it.

```php
use Twig\Attribute\AsTwigFunction;

class ProjectExtension
{
    // Inject hypothetical dependencies
    public function __construct(private LipsumProvider $lipsumProvider) {}

    #[AsTwigFunction('lipsum')]
    public function lipsum(int $count): string
    {
        return $this->lipsumProvider->lipsum($count);
    }
}

$twig = new \Twig\Environment($loader);
$twig->addExtension(new \Twig\Extension\AttributeExtension(ProjectExtension::class));
$twig->addRuntimeLoader(new \Twig\RuntimeLoader\FactoryRuntimeLoader([
    ProjectExtension::class => function () use ($lipsumProvider) {
        return new ProjectExtension($lipsumProvider);
    },
]));
```

--------------------------------

### Twig `same as` example

Source: https://twig.symfony.com/doc/3.x/tests/sameas.html

Checks if the `user.name` attribute is strictly equal to the boolean `false` using the `same as` test. The output is the text inside the `{% if %}` block when the condition is true.

```twig
{% if user.name is same as(false) %}
    the user attribute is the 'false' PHP value
{% endif %}
```

--------------------------------

### Passing a locale to country_name filter

Source: https://twig.symfony.com/doc/3.x/filters/country_name.html

Passes a locale explicitly to the filter. The first example uses 'fr' to get 'États-Unis' for 'US', and the second uses 'zh_Hant_HK' to get '美國'.

```twig
{# États-Unis #}
{{ 'US'|country_name('fr') }}

{# 美國 #}
{{ 'US'|country_name('zh_Hant_HK') }}
```

--------------------------------

### form_start(form_view, variables)

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Renders the <form> opening tag with the configured method, action, and enctype (when the form has file uploads).

```APIDOC
## form_start(form_view, variables)

### Description
Renders the `<form>` opening tag with the configured method, action, and `enctype` (when the form has file uploads).

### Parameters
- **form_view** (FormView) - Required - The form view object.
- **variables** (array) - Optional - Additional variables, e.g., `{method: 'GET'}`.

### Example
```twig
{{ form_start(form, {method: 'GET'}) }}
```
```

--------------------------------

### format_list filter

Source: https://twig.symfony.com/doc/3.x/filters/format_list.html

Documentation for the Twig `format_list` filter, including usage, arguments, examples, and installation requirements.

```APIDOC
## `format_list` filter

### Description
Formats a list of strings as a single, locale-aware string. The filter supports different types (and, or, units) and widths (wide, short, narrow).

### Usage
`{{ ['Apple', 'Banana', 'Cherry']|format_list(type: 'and', width: 'wide', locale: 'en') }}`

### Arguments
- **type** (string) - Optional - The type of the list output: `and` (default), `or`, or `units`.
- **width** (string) - Optional - The width of the list output: `wide` (default), `short`, or `narrow`.
- **locale** (string) - Optional - The locale code as defined in RFC 5646. Defaults to the current locale.

### Examples
```twig
{# en: Apple, Banana, and Cherry #}
{{ ['Apple', 'Banana', 'Cherry']|format_list }}

{# en: Apple, Banana, and Cherry #}
{{ ['Apple', 'Banana', 'Cherry']|format_list(type: 'and', locale: 'en') }}

{# en: Apple, Banana, or Cherry #}
{{ ['Apple', 'Banana', 'Cherry']|format_list(type: 'or', locale: 'en') }}

{# en: Apple, Banana, Cherry #}
{{ ['Apple', 'Banana', 'Cherry']|format_list(type: 'units', locale: 'en') }}

{# en: Apple, Banana, and Cherry #}
{{ ['Apple', 'Banana', 'Cherry']|format_list(width: 'wide', locale: 'en') }}

{# en: Apple, Banana, & Cherry #}
{{ ['Apple', 'Banana', 'Cherry']|format_list(width: 'short', locale: 'en') }}

{# en: Apple, Banana, Cherry #}
{{ ['Apple', 'Banana', 'Cherry']|format_list(width: 'narrow', locale: 'en') }}

{# fr: Apple, Banana et Cherry #}
{{ ['Apple', 'Banana', 'Cherry']|format_list(locale: 'fr') }}
```

### Requirements
- The `format_list` filter requires the `IntlListFormatter` class, available since PHP 8.5.
- The filter is part of the `IntlExtension`, which is not installed by default. Install it via Composer:
  ```
  $ composer require twig/intl-extra
  ```
- On Symfony projects, install the `twig/extra-bundle`:
  ```
  $ composer require twig/extra-bundle
  ```
- Otherwise, add the extension explicitly on the Twig environment:
  ```php
  use Twig\Extra\Intl\IntlExtension;

  $twig = new \Twig\Environment(...);
  $twig->addExtension(new IntlExtension());
  ```
```

--------------------------------

### Display a variable assigned with set

Source: https://twig.symfony.com/doc/3.x/tags/set.html

Displays the value of the `name` variable, which was assigned in the previous example. The comment `{# displays Fabien #}` indicates the expected output.

```twig
{# displays Fabien #}
{{ name }}
```

--------------------------------

### Use format_*_number filters with style

Source: https://twig.symfony.com/doc/3.x/filters/format_number.html

Uses the format_*_number filters by replacing * with a style. The first example formats a number as a percentage, the second as spelled-out text.

```twig
{# 1,234% #}
{{ '12.345'|format_percent_number }}

{# twelve point three four five #}
{{ '12.345'|format_spellout_number }}
```

--------------------------------

### Using currency_name filter with explicit locale

Source: https://twig.symfony.com/doc/3.x/filters/currency_name.html

Passes the locale explicitly as an argument to the filter. The example uses 'fr_FR' to get the French currency name.

```twig
{# yen japonais #}
{{ 'JPY'|currency_name('fr_FR') }}
```

--------------------------------

### Documenting Template Constructs with Documentation Comments

Source: https://twig.symfony.com/doc/3.x/documentation_comments.html

Place a documentation comment before an output statement, block tag, or macro to describe it. Comments start with `{##` and can use the regular `#}` or symmetric `##}` closing marker. They do not affect rendering.

```twig
{## Displays the title of the current page. ##}
{{ page_title }}

{## Displays the main content of the page. ##}
{% block content %}
    ...
{% endblock %}

{## Renders an HTML input. ##}
{% macro input(name, value = null) %}
    ...
{% endmacro %}
```

--------------------------------

### Using the verbatim tag to display Twig syntax

Source: https://twig.symfony.com/doc/3.x/tags/verbatim.html

Wrap Twig code with {% verbatim %} and {% endverbatim %} to output it as raw text without parsing. This is useful for showing Twig syntax examples inside a template.

```twig
{% verbatim %}
    <ul>
    {% for item in seq %}
        <li>{{ item }}</li>
    {% endfor %}
    </ul>
{% endverbatim %}
```

--------------------------------

### Add and prepend paths to FilesystemLoader

Source: https://twig.symfony.com/doc/3.x/api.html

Shows how to add and prepend template paths using addPath() and prependPath(). These methods affect the 'main' namespace when no namespace is specified.

```php
$loader->addPath($templateDir3);
$loader->prependPath($templateDir4);
```

--------------------------------

### Create FilesystemLoader with relative path and root path

Source: https://twig.symfony.com/doc/3.x/api.html

Uses a relative path for templates and a root path for resolving relative paths. This makes cache keys independent of the project root directory.

```php
$loader = new \Twig\Loader\FilesystemLoader('templates', getcwd().'/..');
```

--------------------------------

### display()

Source: https://twig.symfony.com/doc/3.x/api.html

A shortcut to output the rendered template directly.

```APIDOC
## display()

### Description
A shortcut to output the rendered template directly.

### Method
display

### Parameters
- **context** (array) - Required - An associative array of variables to pass to the template.

### Return Value
- **void** - Outputs the rendered template.

### Example
```php
$template->display(['the' => 'variables', 'go' => 'here']);
```
```

--------------------------------

### Create FilesystemLoader with a single directory

Source: https://twig.symfony.com/doc/3.x/api.html

Instantiates a FilesystemLoader with a single template directory. This is the preferred way to load templates from the file system.

```php
$loader = new \Twig\Loader\FilesystemLoader($templateDir);
```

--------------------------------

### form_help(form_view, variables)

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Renders the help text configured via the 'help' option.

```APIDOC
## form_help(form_view, variables)

### Description
Renders the help text configured via the `help` option.

### Parameters
- **form_view** (FormView) - Required - The form view object.
- **variables** (array) - Optional - Additional variables.

### Example
```twig
{{ form_help(form.name) }}
```
```

--------------------------------

### Render help text with form_help()

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Renders the help text configured via the 'help' option.

```twig
{{ form_help(form.name) }}
```

--------------------------------

### field_*() helpers for custom HTML

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

When you need full control over the HTML (bypassing themes), use the field_*() helpers that return raw values. This example shows a text input and a select dropdown.

```twig
<input
    type="text"
    name="{{ field_name(form.username) }}"
    id="{{ form.username.vars.id }}"
    value="{{ field_value(form.username) }}"
    placeholder="{{ field_label(form.username) }}"
>

<select name="{{ field_name(form.country) }}">
    <option value="">Choose...</option>
    {% for label, value in field_choices(form.country) %}
        <option value="{{ value }}">{{ label }}</option>
    {% endfor %}
</select>
```

--------------------------------

### Profiler Extension: Upload Profile with Blackfire CLI

Source: https://twig.symfony.com/doc/3.x/api.html

Uploads the generated profile to Blackfire.io for visualization. Requires a free account.

```bash
blackfire --slot=7 upload /path/to/profile.prof
```

--------------------------------

### Defining functions via getFunctions()

Source: https://twig.symfony.com/doc/3.x/advanced.html

Shows how to register a function in an extension by overriding getFunctions() and returning an array of TwigFunction instances.

```php
class CustomTwigExtension extends \Twig\Extension\AbstractExtension
{
    public function getFunctions()
    {
        return [
            new \Twig\TwigFunction('lipsum', 'generate_lipsum'),
        ];
    }

    // ...
}
```

--------------------------------

### \Twig\Loader\ArrayLoader

Source: https://twig.symfony.com/doc/3.x/api.html

Documentation for the Twig ArrayLoader class, including constructor and usage example.

```APIDOC
## \Twig\Loader\ArrayLoader

### Description
Loads a template from a PHP array. It is passed an array of strings bound to template names. This loader is very useful for unit testing and for small projects where storing all templates in a single PHP file might make sense.

### Constructor

#### `new \Twig\Loader\ArrayLoader($templates)`

- **$templates** (array) - Required - An associative array mapping template names to template source code.

### Usage Example

```php
$loader = new \Twig\Loader\ArrayLoader([
    'index.html.twig' => 'Hello {{ name }}!',
]);
$twig = new \Twig\Environment($loader);

echo $twig->render('index.html.twig', ['name' => 'Fabien']);
```
```

--------------------------------

### field_value() usage

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Returns the current value of the field. This example pre-fills a custom input.

```twig
{# pre-fill a custom input with the form field's value #}
<input type="range" name="{{ field_name(form.rating) }}" value="{{ field_value(form.rating) }}">
```

--------------------------------

### Create FilesystemLoader with an array of directories

Source: https://twig.symfony.com/doc/3.x/api.html

Instantiates a FilesystemLoader with an array of directories. Twig will search directories in order and fallback to the next if a template is not found.

```php
$loader = new \Twig\Loader\FilesystemLoader([$templateDir1, $templateDir2]);
```

--------------------------------

### Create a BlockChain with templates in precedence order

Source: https://twig.symfony.com/doc/3.x/api.html

Creates a BlockChain with templates passed from highest to lowest precedence. The first definition of each block wins. Use this when a renderer needs to select blocks from several templates at runtime.

```php
use Twig\BlockChain;

$blocks = new BlockChain($twig, [
    'admin_theme.html.twig',
    $twig->load('application_theme.html.twig'),
    'base_theme.html.twig',
]);

echo $blocks->renderBlock('field_row', ['field' => $field]);
```

--------------------------------

### Render a template with variables using $template->render()

Source: https://twig.symfony.com/doc/3.x/api.html

Renders the loaded template with the given variables and returns the output. The `display()` method is a shortcut that outputs the rendered template directly.

```php
echo $template->render(['the' => 'variables', 'go' => 'here']);
```

--------------------------------

### Escaping applied after other filters

Source: https://twig.symfony.com/doc/3.x/api.html

Shows that escaping is applied after any other filter. The example is equivalent to {{ var|upper|escape }}.

```twig
{{ var|upper }} {# is equivalent to {{ var|upper|escape }} #}
```

--------------------------------

### Create a Twig Sandbox with a SecurityPolicy

Source: https://twig.symfony.com/doc/3.x/sandbox.html

Creates a Twig\Sandbox\Sandbox from a dedicated environment and a strict SecurityPolicy, then renders a template from the loader and from a string. The environment must be dedicated to the sandbox and not used before; the constructor throws a LogicException otherwise. The policy must be strict (setStrict(true)) or the constructor throws a LogicException.

```php
use Twig\Environment;
use Twig\Loader\ArrayLoader;
use Twig\Sandbox\Sandbox;
use Twig\Sandbox\SecurityPolicy;

$env = new Environment(new ArrayLoader($userTemplates), [
    'cache' => '/path/to/sandbox/cache',
]);

$policy = new SecurityPolicy(
    allowedTags: ['include'],
    allowedFilters: ['date', 'escape'],
    allowedMethods: [Article::class => ['getTitle']],
);
$policy->setStrict(true);

$sandbox = new Sandbox($env, $policy);

// render a template known to the environment loader
echo $sandbox->render('newsletter.twig', ['article' => $article]);

// render a template held as a string
echo $sandbox->createTemplate($source)->render(['article' => $article]);
```

--------------------------------

### Load and render directly with $twig->render()

Source: https://twig.symfony.com/doc/3.x/api.html

Loads and renders a template in one call using the Twig environment. Useful for quick rendering without a separate load step.

```php
echo $twig->render('index.html.twig', ['the' => 'variables', 'go' => 'here']);
```

--------------------------------

### \Twig\Loader\ChainLoader

Source: https://twig.symfony.com/doc/3.x/api.html

Documentation for the Twig ChainLoader class, including constructor, addLoader method, and usage example.

```APIDOC
## \Twig\Loader\ChainLoader

### Description
Delegates the loading of templates to other loaders. When looking for a template, Twig tries each loader in turn and returns as soon as the template is found.

### Constructor

#### `new \Twig\Loader\ChainLoader($loaders)`

- **$loaders** (array) - Required - An array of loader instances.

### Methods

#### `addLoader($loader)`

- **$loader** (\Twig\Loader\LoaderInterface) - Required - The loader to add.

### Usage Example

```php
$loader1 = new \Twig\Loader\ArrayLoader([
    'base.html.twig' => '{% block content %}{% endblock %}',
]);
$loader2 = new \Twig\Loader\ArrayLoader([
    'index.html.twig' => '{% extends "base.html.twig" %}{% block content %}Hello {{ name }}{% endblock %}',
    'base.html.twig'  => 'Will never be loaded',
]);

$loader = new \Twig\Loader\ChainLoader([$loader1, $loader2]);

$twig = new \Twig\Environment($loader);
```
```

--------------------------------

### Basic Twig usage with ArrayLoader

Source: https://twig.symfony.com/doc/3.x/intro.html

Shows the minimal PHP API: load a template from an array, create an environment, and render it with variables. The template 'index' contains 'Hello {{ name }}!' and is rendered with name 'Fabien'.

```php
require_once '/path/to/vendor/autoload.php';

$loader = new \Twig\Loader\ArrayLoader([
    'index' => 'Hello {{ name }}!',
]);
$twig = new \Twig\Environment($loader);

echo $twig->render('index', ['name' => 'Fabien']);
```

--------------------------------

### field_choices() usage

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Returns an iterable of label/value pairs for choice fields. This example renders a custom dropdown.

```twig
{# render a custom dropdown for a choice field #}
<ul class="dropdown" role="listbox">
    {% for label, value in field_choices(form.country) %}
        <li role="option" data-value="{{ value }}">{{ label }}</li>
    {% endfor %}
</ul>
```

--------------------------------

### Replacement: getExpressionParsers() method (Twig 3.21)

Source: https://twig.symfony.com/doc/3.x/deprecated.html

Use Twig\Extension\ExtensionInterface::getExpressionParsers() instead of getOperators(). This is the 'after' example.

```php
public function getExpressionParsers(): array {
    return [
        new UnaryOperatorExpressionParser(NotUnary::class, 'not', 10),
    ];
}
```

--------------------------------

### currency_names('fr') with explicit locale

Source: https://twig.symfony.com/doc/3.x/functions/currency_names.html

Passes the 'fr' locale explicitly to get currency names in French.

```twig
{# afghani (1927–2002), afghani afghan, ... #}
{{ currency_names('fr')|join(', ') }}
```

--------------------------------

### Twig column filter example

Source: https://twig.symfony.com/doc/3.x/filters/column.html

Returns the values from the 'fruit' column of the items array, producing ['apple', 'orange'].

```twig
{% set items = [{ 'fruit' : 'apple'}, {'fruit' : 'orange' }] %}

{% set fruits = items|column('fruit') %}

{# fruits now contains ['apple', 'orange'] #}
```

--------------------------------

### Defining tags via getTokenParsers()

Source: https://twig.symfony.com/doc/3.x/advanced.html

Shows how to register a tag in an extension by overriding getTokenParsers() and returning an array of token parser instances.

```php
class CustomTwigExtension extends \Twig\Extension\AbstractExtension
{
    public function getTokenParsers()
    {
        return [new CustomSetTokenParser()];
    }

    // ...
}
```

--------------------------------

### html_to_markdown filter

Source: https://twig.symfony.com/doc/3.x/filters/html_to_markdown.html

Converts a block of HTML to Markdown. Can be used with the apply tag or on an included template. Requires the MarkdownExtension to be installed.

```APIDOC
## html_to_markdown filter

### Description
Converts a block of HTML to Markdown. The filter is part of the MarkdownExtension, which is not installed by default. It can be used with the `apply` tag or on an included template.

### Usage
Use the filter with the `apply` tag:
```twig
{% apply html_to_markdown %}
    <html>
        <h1>Hello!</h1>
    </html>
{% endapply %}
```

Or on an included template:
```twig
{{ include('some_template.html.twig')|html_to_markdown }}
```

### Arguments
Optional arguments can be passed to the filter, depending on the underlying conversion library. Example for `league/html-to-markdown`:
```twig
{% apply html_to_markdown({hard_break: false}) %}
    <html>
        <h1>Hello!</h1>
    </html>
{% endapply %}
```

### Installation
Install the MarkdownExtension via Composer:
```
$ composer require twig/markdown-extra
```

On Symfony projects, install `twig/extra-bundle`:
```
$ composer require twig/extra-bundle
```

Or add the extension explicitly:
```php
use Twig\Extra\Markdown\MarkdownExtension;

$twig = new \Twig\Environment(...);
$twig->addExtension(new MarkdownExtension());
```

If not using Symfony, register the extension runtime:
```php
use Twig\Extra\Markdown\DefaultMarkdown;
use Twig\Extra\Markdown\MarkdownRuntime;
use Twig\RuntimeLoader\RuntimeLoaderInterface;

$twig->addRuntimeLoader(new class implements RuntimeLoaderInterface {
    public function load($class) {
        if (MarkdownRuntime::class === $class) {
            return new MarkdownRuntime(new DefaultMarkdown());
        }
    }
});
```

### Supported Libraries
The actual conversion is done by one of the following compatible libraries:
- league/html-to-markdown
- michelf/php-markdown
- erusev/parsedown
```

--------------------------------

### Pass variables explicitly to include_only

Source: https://twig.symfony.com/doc/3.x/functions/include_only.html

Variables must be passed explicitly as an associative array. The example passes only the 'name' variable.

```twig
{# template.html.twig only gets the "name" variable from the caller #}
{{ include_only('template.html.twig', {name: 'Fabien'}) }}
```

--------------------------------

### Using a global object with a lipsum method

Source: https://twig.symfony.com/doc/3.x/advanced.html

Shows how to use a global object with a method to generate Lorem ipsum text. This is an alternative to functions, useful for helper objects.

```twig
{{ text.lipsum(40) }}
```

--------------------------------

### format_number with grouping_used

Source: https://twig.symfony.com/doc/3.x/filters/format_number.html

Uses the grouping_used option to enable thousands separators. The locale is set to 'en' to get the comma grouping.

```twig
{# 1,234,567.89 #}
{{ 1234567.89|format_number({grouping_used:true}, locale: 'en') }}
```

--------------------------------

### render()

Source: https://twig.symfony.com/doc/3.x/api.html

Renders a template with the given variables and returns the output as a string.

```APIDOC
## render()

### Description
Renders a template with the given variables and returns the output as a string.

### Method
render

### Parameters
- **context** (array) - Required - An associative array of variables to pass to the template.

### Return Value
- **string** - The rendered template output.

### Example
```php
echo $template->render(['the' => 'variables', 'go' => 'here']);
```
```

--------------------------------

### Spacing around delimiters (non-empty content)

Source: https://twig.symfony.com/doc/3.x/coding_standards.html

Put exactly one space after the start of a delimiter ({{, {%, {#) and before the end (}}, %}, #}) if the content is non-empty.

```twig
{{ user }}
{# comment #} {##}
{% if user %}{% endif %}
```

--------------------------------

### format_number with format_width and padding_position

Source: https://twig.symfony.com/doc/3.x/filters/format_number.html

Sets the width and padding position for the formatted number. The example uses format_width 10 and padding_position 'before_suffix'.

```twig
{# 123 #}
{{ 123|format_number({format_width:10, padding_position:'before_suffix'}, locale: 'en') }}
```

--------------------------------

### format_number with rounding_mode and rounding_increment

Source: https://twig.symfony.com/doc/3.x/filters/format_number.html

Controls rounding behavior using rounding_mode and rounding_increment. The example uses 'ceiling' rounding with an increment of 0.05.

```twig
{# 123.5 #}
{{ 123.456|format_number({rounding_mode:'ceiling', rounding_increment:0.05}, locale: 'en') }}
```

--------------------------------

### Move runtime logic to a separate CustomTwigRuntime class

Source: https://twig.symfony.com/doc/3.x/advanced.html

Shows the recommended approach: moving runtime logic to a dedicated CustomTwigRuntime class and referencing it from the extension using either an array callable or a static method string. This decouples the extension from runtime dependencies.

```php
class CustomTwigRuntime
{
    private $rot13Provider;

    public function __construct($rot13Provider)
    {
        $this->rot13Provider = $rot13Provider;
    }

    public function rot13($value)
    {
        return $this->rot13Provider->rot13($value);
    }
}

class CustomTwigExtension extends \Twig\Extension\AbstractExtension
{
    public function getFunctions()
    {
        return [
            new \Twig\TwigFunction('rot13', ['CustomTwigRuntime', 'rot13']),
            // or
            new \Twig\TwigFunction('rot13', 'CustomTwigRuntime::rot13'),
        ];
    }
}
```

--------------------------------

### Defining filters via getFilters()

Source: https://twig.symfony.com/doc/3.x/advanced.html

Shows how to register a filter in an extension by overriding getFilters() and returning an array of TwigFilter instances.

```php
class CustomTwigExtension extends \Twig\Extension\AbstractExtension
{
    public function getFilters()
    {
        return [
            new \Twig\TwigFilter('rot13', 'str_rot13'),
        ];
    }

    // ...
}
```

--------------------------------

### Filter a sequence with for tag

Source: https://twig.symfony.com/doc/3.x/filters/filter.html

Combines the `filter` filter with the `for` tag to iterate over filtered items. The example outputs values greater than 38.

```twig
{% for v in sizes|filter(v => v > 38) -%}
    {{ v }}
{% endfor %}
{# output 40 42 #}
```

--------------------------------

### Profiler Extension: Dump Blackfire.io Format

Source: https://twig.symfony.com/doc/3.x/api.html

Dumps the profile in a Blackfire.io compatible format and writes it to a file. Upload the file to visualize it.

```php
$dumper = new \Twig\Profiler\Dumper\BlackfireDumper();
file_put_contents('/path/to/profile.prof', $dumper->dump($profile));
```

--------------------------------

### markdown_to_html filter

Source: https://twig.symfony.com/doc/3.x/filters/markdown_to_html.html

The markdown_to_html filter converts a block of Markdown to HTML. It can be applied to blocks, included files, or variables. It requires the MarkdownExtension to be installed.

```APIDOC
## markdown_to_html filter

### Description
The `markdown_to_html` filter converts a block of Markdown to HTML. It can be applied to blocks, included files, or variables. It requires the `MarkdownExtension` to be installed.

### Usage
Apply the filter to a block:
```twig
{% apply markdown_to_html %}
Title
=====

Hello!
{% endapply %}
```

Apply the filter to an included file or a variable:
```twig
{{ include('some_template.markdown.twig')|markdown_to_html }}

{{ changelog|markdown_to_html }}
```

### Installation
Install the `twig/markdown-extra` package:
```
$ composer require twig/markdown-extra
```

On Symfony projects, install the `twig/extra-bundle`:
```
$ composer require twig/extra-bundle
```

Otherwise, add the extension explicitly:
```php
use Twig\Extra\Markdown\MarkdownExtension;

$twig = new \Twig\Environment(...);
$twig->addExtension(new MarkdownExtension());
```

If not using Symfony, register the extension runtime:
```php
use Twig\Extra\Markdown\DefaultMarkdown;
use Twig\Extra\Markdown\MarkdownRuntime;
use Twig\RuntimeLoader\RuntimeLoaderInterface;

$twig->addRuntimeLoader(new class implements RuntimeLoaderInterface {
    public function load($class) {
        if (MarkdownRuntime::class === $class) {
            return new MarkdownRuntime(new DefaultMarkdown());
        }
    }
});
```

### Custom Converter
The filter delegates conversion to a class implementing `Twig\Extra\Markdown\MarkdownInterface`. Provided implementations: `LeagueMarkdown`, `MichelfMarkdown`, `ErusevMarkdown`, `TempestMarkdown`. Each accepts a pre-configured converter in its constructor.

Example with `ErusevMarkdown`:
```php
use Twig\Extra\Markdown\ErusevMarkdown;

$parsedown = new \ParsedownExtra();
$parsedown->setSafeMode(true);

$markdown = new ErusevMarkdown($parsedown);
```

When using `twig/extra-bundle`, register your converter as the `twig.markdown.default` service:
```yaml
# config/services.yaml
services:
    twig.markdown.default:
        class: Twig\Extra\Markdown\ErusevMarkdown
        arguments:
            - '@my_configured_parsedown'
```

### Notes
- The output is marked as safe for HTML.
- The default `tempest/markdown` converter passes raw HTML and unsafe links through, so only use it on trusted input.
- If using `league/commonmark`, prefer the `commonmark` configuration of the bundle (e.g., `html_input: escape` and `allow_unsafe_links: false`) to protect against XSS.
```

--------------------------------

### Render a field row with form_row()

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Renders a complete field row (label, widget, help, errors). The example passes a custom label.

```twig
{{ form_row(form.name, {'label': 'Custom Label'}) }}
```

--------------------------------

### Render form with form_start(), form_errors(), form_row(), form_end()

Source: https://twig.symfony.com/doc/3.x/tests/rootform.html

Renders a form with more control using individual helpers: form_start, form_errors, form_row for each field, and form_end. This is recommended over form() for more control.

```twig
{{ form_start(form) }}
    {{ form_errors(form) }}

    {{ form_row(form.name) }}
    {{ form_row(form.dueDate) }}

    {{ form_row(form.submit, {label: 'Submit me'}) }}
{{ form_end(form) }}
```

--------------------------------

### Create ArrayLoader and render a template

Source: https://twig.symfony.com/doc/3.x/api.html

Creates an ArrayLoader with a template string and renders it. Useful for unit testing or small projects.

```php
$loader = new \Twig\Loader\ArrayLoader([
    'index.html.twig' => 'Hello {{ name }}!',
]);
$twig = new \Twig\Environment($loader);

echo $twig->render('index.html.twig', ['name' => 'Fabien']);
```

--------------------------------

### Iterating over a string with the split filter

Source: https://twig.symfony.com/doc/3.x/tags/for.html

Uses the `split` filter to iterate over the characters of a string. The example uses a Japanese phrase and trims whitespace with `-%}`.

```twig
<h1>Characters</h1>
<ul>
    {% for char in "諺 / ことわざ"|split('') -%}
        <li>{{ char }}</li>
    {%- endfor %}
</ul>
```

--------------------------------

### Twig sequence test example

Source: https://twig.symfony.com/doc/3.x/tests/sequence.html

Checks if the `users` variable is a sequence and iterates over it if true. The test evaluates to true for arrays and Traversable objects.

```twig
{% set users = ["Alice", "Bob"] %}
{# evaluates to true if the users variable is a sequence #}
{% if users is sequence %}
    {% for user in users %}
        Hello {{ user }}!
    {% endfor %}
{% endif %}
```

--------------------------------

### Load a template with $twig->load()

Source: https://twig.symfony.com/doc/3.x/api.html

Loads a template file and returns a \Twig\TemplateWrapper instance. Use this to load a template before rendering or inspecting it.

```php
$template = $twig->load('index.html.twig');
```

--------------------------------

### Deprecated: getOperators() method (Twig 3.21)

Source: https://twig.symfony.com/doc/3.x/deprecated.html

The Twig\Extension\ExtensionInterface::getOperators() method is deprecated as of Twig 3.21. Use getExpressionParsers() instead. This is the 'before' example.

```php
public function getOperators(): array {
    return [
        'not' => [
            'precedence' => 10,
            'class' => NotUnary::class,
        ],
    ];
}
```

--------------------------------

### \Twig\Environment constructor

Source: https://twig.symfony.com/doc/3.x/api.html

Creates a new Twig Environment instance with configurable options.

```APIDOC
## \Twig\Environment constructor

### Description
Creates a new Twig Environment instance. The constructor accepts a loader and an optional array of options.

### Method
__construct

### Parameters
- **loader** (mixed) - Required - The loader instance used to load templates.
- **options** (array) - Optional - An associative array of environment options.

### Options
- **debug** (boolean) - Optional - When set to `true`, generated templates have a `__toString()` method to display generated nodes. Defaults to `false`.
- **charset** (string) - Optional - The charset used by the templates. Defaults to `utf-8`.
- **cache** (string|false) - Optional - An absolute path to store compiled templates, or `false` to disable caching. Defaults to `false`.
- **auto_reload** (boolean) - Optional - Recompile templates when source changes. If not provided, determined automatically based on `debug`.
- **strict_variables** (boolean) - Optional - If `false`, silently ignore invalid variables and replace with `null`. If `true`, throw an exception. Defaults to `false`.
- **autoescape** (string|callable|false) - Optional - Sets the default auto-escaping strategy. Can be `name`, `html`, `js`, `css`, `url`, `html_attr`, `html_attr_relaxed`, a PHP callback, or `false` to disable. The `name` strategy determines escaping based on template filename extension.
- **optimizations** (integer) - Optional - A flag indicating which optimizations to apply. Defaults to `-1` (all enabled). Set to `0` to disable.
- **use_yield** (boolean) - Optional - If `true`, forces templates to exclusively use `yield`. If `false` (default), allows a mix of `yield` and `echo` for progressive migration.

### Request Example
```php
$twig = new \Twig\Environment($loader, ['debug' => true]);
```
```

--------------------------------

### Use TemplateWrapper with include_only

Source: https://twig.symfony.com/doc/3.x/functions/include_only.html

If the expression evaluates to a \Twig\TemplateWrapper instance, Twig uses it directly. The example shows loading a template and passing it as a variable.

```php
// {{ include_only(template) }}

$template = $twig->load('some_template.html.twig');

$twig->display('template.html.twig', ['template' => $template]);
```

--------------------------------

### Check if variable is divisible by 3

Source: https://twig.symfony.com/doc/3.x/tests/divisibleby.html

Use the divisible by test to check if a variable is divisible by a number. In this example, the test checks if loop.index is divisible by 3.

```twig
{% if loop.index is divisible by(3) %}
    ...
{% endif %}
```
Tokens:
Raw