aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/twig/twig/doc/filters/batch.rst
blob: 4366b57b09ed5ae6a3454e39e3b0496cf59c9d08 (plain) (blame)
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
``batch``
=========

.. versionadded:: 1.12.3
    The batch filter was added in Twig 1.12.3.

The ``batch`` filter "batches" items by returning a list of lists with the
given number of items. If you provide a second parameter, it is used to fill
missing items:

.. code-block:: jinja

    {% set items = ['a', 'b', 'c', 'd', 'e', 'f', 'g'] %}

    <table>
    {% for row in items|batch(3, 'No item') %}
      <tr>
      {% for column in row %}
        <td>{{ column }}</td>
      {% endfor %}
      </tr>
    {% endfor %}
    </table>

The above example will be rendered as:

.. code-block:: jinja

    <table>
      <tr>
          <td>a</td>
          <td>b</td>
          <td>c</td>
        </tr>
      <tr>
          <td>d</td>
          <td>e</td>
          <td>f</td>
        </tr>
      <tr>
          <td>g</td>
          <td>No item</td>
          <td>No item</td>
        </tr>
    </table>