aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/twig/twig/doc/functions/date.rst
blob: f1c948193e031afb5d348a33bc369805fdf2e301 (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
46
47
48
49
50
51
52
``date``
========

.. versionadded:: 1.6
    The date function has been added in Twig 1.6.

.. versionadded:: 1.6.1
    The default timezone support has been added in Twig 1.6.1.

Converts an argument to a date to allow date comparison:

.. code-block:: jinja

    {% if date(user.created_at) < date('-2days') %}
        {# do something #}
    {% endif %}

The argument must be in a format supported by the `date`_ function.

You can pass a timezone as the second argument:

.. code-block:: jinja

    {% if date(user.created_at) < date('-2days', 'Europe/Paris') %}
        {# do something #}
    {% endif %}

If no argument is passed, the function returns the current date:

.. code-block:: jinja

    {% if date(user.created_at) < date() %}
        {# always! #}
    {% endif %}

.. note::

    You can set the default timezone globally by calling ``setTimezone()`` on
    the ``core`` extension instance:

    .. code-block:: php

        $twig = new Twig_Environment($loader);
        $twig->getExtension('core')->setTimezone('Europe/Paris');

Arguments
---------

 * ``date``:     The date
 * ``timezone``: The timezone

.. _`date`: http://www.php.net/date