File: plural.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 (53 lines) | stat: -rw-r--r-- 1,416 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
``plural``
==========

.. versionadded:: 3.11

    The ``plural`` filter was added in Twig 3.11.

The ``plural`` filter transforms a given noun in its singular form into its
plural version:

.. code-block:: twig

    {# English (en) rules are used by default #}
    {{ 'animal'|plural() }}
    animals

    {{ 'animal'|plural('fr') }}
    animaux

.. note::

    The ``plural`` filter is part of the ``StringExtension`` which is not
    installed by default. Install it first:

    .. code-block:: bash

        $ composer require twig/string-extra

    Then, on Symfony projects, install the ``twig/extra-bundle``:

    .. code-block:: bash

        $ composer require twig/extra-bundle

    Otherwise, add the extension explicitly on the Twig environment::

        use Twig\Extra\String\StringExtension;

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

Arguments
---------

* ``locale``: The locale of the original string (limited to languages supported by the from Symfony `inflector`_, part of the String component)
* ``all``: Whether to return all possible plurals as an array, default is ``false``

.. note::

    Internally, Twig uses the `pluralize`_ method from the Symfony String component.

.. _`inflector`: https://symfony.com/doc/current/components/string.html#inflector
.. _`pluralize`: https://symfony.com/doc/current/components/string.html#inflector