added documentation for the trim filter

2026-09-11 18:06:46 +00:00 · 2012-03-22 14:34:27 +01:00
parent 4a0773a8ad
commit a4fa6db03b
1 changed files with 24 additions and 0 deletions
@@ -0,0 +1,24 @@
+``trim``
+========
+
+.. versionadded:: 1.6.2
+    The trim filter was added in Twig 1.6.2.
+
+The ``trim`` filter strips whitespace (or other characters) from the beginning
+and end of a string:
+
+.. code-block:: jinja
+
+    {{ '  I like Twig.  '|trim }}
+
+    {# outputs 'I like Twig.' #}
+
+    {{ '  I like Twig.'|trim('.') }}
+
+    {# outputs '  I like Twig' #}
+
+.. note::
+
+    Internally, Twig uses the PHP `trim`_ function.
+
+.. _`trim`: http://php.net/trim