singular

You are reading the documentation for Twig 3.x. Switch to the documentation for Twig 1.x, 2.x.

Questions & Feedback

Found a typo or an error?
Want to improve this document? Edit it.

Need support or have a technical question?
Ask support on Stack Overflow.

License

Twig documentation is licensed under the new BSD license.

`singular`

3.11

The singular filter was added in Twig 3.11.

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

        1
2
3
4
5
6
        {# 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:

        1
        $ composer require twig/string-extra
    

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

        1
        $ composer require twig/extra-bundle
    

Otherwise, add the extension explicitly on the Twig environment:

        1
2
3
4
        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 singularize method from the Symfony String component.