Yaffs site version 1.1
[yaffs-website] / vendor / twig / twig / doc / filters / striptags.rst
diff --git a/vendor/twig/twig/doc/filters/striptags.rst b/vendor/twig/twig/doc/filters/striptags.rst
new file mode 100644 (file)
index 0000000..82953b7
--- /dev/null
@@ -0,0 +1,29 @@
+``striptags``
+=============
+
+The ``striptags`` filter strips SGML/XML tags and replace adjacent whitespace
+by one space:
+
+.. code-block:: jinja
+
+    {{ some_html|striptags }}
+
+You can also provide tags which should not be stripped:
+
+.. code-block:: jinja
+
+    {{ some_html|striptags('<br><p>') }}
+
+In this example, the ``<br/>``, ``<br>``, ``<p>``, and ``</p>`` tags won't be
+removed from the string.
+
+.. note::
+
+    Internally, Twig uses the PHP `strip_tags`_ function.
+
+Arguments
+---------
+
+* ``allowable_tags``: Tags which should not be stripped
+
+.. _`strip_tags`: http://php.net/strip_tags