aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/twig/twig/doc/filters/first.rst
blob: 4295e83340cd032f33b6922c68ba36619139fc18 (plain) (blame)
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
``first``
=========

.. versionadded:: 1.12.2
    The first filter was added in Twig 1.12.2.

The ``first`` filter returns the first "element" of a sequence, a mapping, or
a string:

.. code-block:: jinja

    {{ [1, 2, 3, 4]|first }}
    {# outputs 1 #}

    {{ { a: 1, b: 2, c: 3, d: 4 }|first }}
    {# outputs 1 #}

    {{ '1234'|first }}
    {# outputs 1 #}

.. note::

    It also works with objects implementing the `Traversable`_ interface.

.. _`Traversable`: http://php.net/manual/en/class.traversable.php