shuffle

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.

`shuffle`

3.11

The shuffle filter was added in Twig 3.11.

The shuffle filter shuffles a sequence, a mapping, or a string:

        1
2
3
        {% for user in users|shuffle %}
    ...
{% endfor %}
    

Caution

The shuffled array does not preserve keys. So if the input had not sequential keys but indexed keys (using the user id for instance), it is not the case anymore after shuffling it.

Example 1:

        1
2
3
4
5
6
7
8
9
10
11
        {% set items = [
    'a',
    'b',
    'c',
] %}

<ul>
    {% for item in items|shuffle %}
        <li>{{ item }}</li>
    {% endfor %}
</ul>
    

The above example will be rendered as:

        1
2
3
4
5
        <ul>
    <li>a</li>
    <li>c</li>
    <li>b</li>
</ul>
    

The result can also be: "a, b, c" or "b, a, c" or "b, c, a" or "c, a, b" or "c, b, a".

Example 2:

        1
2
3
4
5
6
7
8
9
10
11
        {% set items = {
    'a': 'd',
    'b': 'e',
    'c': 'f',
} %}

<ul>
    {% for index, item in items|shuffle %}
        <li>{{ index }} - {{ item }}</li>
    {% endfor %}
</ul>
    

The above example will be rendered as:

        1
2
3
4
5
        <ul>
    <li>0 - d</li>
    <li>1 - f</li>
    <li>2 - e</li>
</ul>
    

The result can also be: "d, e, f" or "e, d, f" or "e, f, d" or "f, d, e" or "f, e, d".

        1
2
3
        {% set string = 'ghi' %}

<p>{{ string|shuffle }}</p>
    

The above example will be rendered as:

        1
        <p>gih</p>
    

The result can also be: "ghi" or "hgi" or "hig" or "igh" or "ihg".