``shuffle``
===========

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

.. code-block:: twig

    {% 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:

.. code-block:: html+twig

    {% set items = [
        'a',
        'b',
        'c',
    ] %}

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

The above example will be rendered as:

.. code-block:: html

    <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:

.. code-block:: html+twig

    {% 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:

.. code-block:: html

    <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".

.. code-block:: html+twig

    {% set string = 'ghi' %}

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

The above example will be rendered as:

.. code-block:: html

    <p>gih</p>

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