File: set.rst

package info (click to toggle)
php-twig 3.20.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,940 kB
  • sloc: php: 23,320; makefile: 110; sh: 43
file content (78 lines) | stat: -rw-r--r-- 1,757 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
``set``
=======

Inside code blocks you can also assign values to variables. Assignments use
the ``set`` tag and can have multiple targets.

Here is how you can assign the ``Fabien`` value to the ``name`` variable:

.. code-block:: twig

    {% set name = 'Fabien' %}

After the ``set`` call, the ``name`` variable is available in the template like
any other ones:

.. code-block:: twig

    {# displays Fabien #}
    {{ name }}

The assigned value can be any valid :ref:`Twig expression
<twig-expressions>`:

.. code-block:: twig

    {% set numbers = [1, 2] %}
    {% set user = {'name': 'Fabien'} %}
    {% set name = 'Fabien' ~ ' ' ~ 'Potencier' %}

Several variables can be assigned in one block:

.. code-block:: twig

    {% set first, last = 'Fabien', 'Potencier' %}

    {# is equivalent to #}

    {% set first = 'Fabien' %}
    {% set last = 'Potencier' %}

The ``set`` tag can also be used to "capture" chunks of text:

.. code-block:: html+twig

    {% set content %}
        <div id="pagination">
            ...
        </div>
    {% endset %}

.. caution::

    If you enable automatic output escaping, Twig will only consider the
    content to be safe when capturing chunks of text.

.. note::

    Note that loops are scoped in Twig; therefore a variable declared inside a
    ``for`` loop is not accessible outside the loop itself:

    .. code-block:: twig

        {% for item in items %}
            {% set value = item %}
        {% endfor %}

        {# value is NOT available #}

    If you want to access the variable, just declare it before the loop:

    .. code-block:: twig

        {% set value = "" %}
        {% for item in items %}
            {% set value = item %}
        {% endfor %}

        {# value is available #}