Add docs for date_modify
authorJordi Boggiano <j.boggiano@seld.be>
Wed, 20 Jun 2012 17:45:35 +0000 (19:45 +0200)
committerJordi Boggiano <j.boggiano@seld.be>
Wed, 20 Jun 2012 17:45:35 +0000 (19:45 +0200)
doc/filters/date_modify.rst [new file with mode: 0644]

diff --git a/doc/filters/date_modify.rst b/doc/filters/date_modify.rst
new file mode 100644 (file)
index 0000000..303263b
--- /dev/null
@@ -0,0 +1,18 @@
+``date_modify``
+===============
+
+.. versionadded:: 1.9
+    The date_modify filter has been added in Twig 1.9.
+
+The ``date_modify`` filter modifies a date with a given modifier string:
+
+.. code-block:: jinja
+
+    {{ post.published_at|date_modify("+1 day")|date("m/d/Y") }}
+
+The ``date_modify`` filter accepts strings (it must be in a format supported by the
+`strtotime`_ function) or `DateTime`_ instances. You can easily combine it with the `date`_
+filter for formatting.
+
+.. _`strtotime`:    http://www.php.net/strtotime
+.. _`DateTime`:     http://www.php.net/DateTime