Files
Twig/doc/filters/singular.rst
T
Fabien Potencier b8e6b314b3 Merge branch '3.x' into 4.x
* 3.x:
  fix documentation typos for singular filter arguments
  Add getOperatorTokens() to ExpressionParserInterface to separate operator token registration from parser identity
  Ensure filters/attributes aren't mistaken for operators
2026-02-25 09:40:35 +01:00

50 lines
1.3 KiB
ReStructuredText

``singular``
============
The ``singular`` filter transforms a given noun in its plural form into its
singular version:
.. code-block:: twig
{# English (en) rules are used by default #}
{{ 'partitions'|singular() }}
partition
{{ 'partitions'|singular('fr') }}
partition
.. note::
The ``singular`` 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 singulars as an array, default is ``false``
.. note::
Internally, Twig uses the `singularize`_ method from the Symfony String component.
.. _`inflector`: https://symfony.com/doc/current/components/string.html#inflector
.. _`singularize`: https://symfony.com/doc/current/components/string.html#inflector