Yaffs site version 1.1
[yaffs-website] / vendor / twig / twig / doc / functions / source.rst
diff --git a/vendor/twig/twig/doc/functions/source.rst b/vendor/twig/twig/doc/functions/source.rst
new file mode 100644 (file)
index 0000000..3c921b1
--- /dev/null
@@ -0,0 +1,32 @@
+``source``
+==========
+
+.. versionadded:: 1.15
+    The ``source`` function was added in Twig 1.15.
+
+.. versionadded:: 1.18.3
+    The ``ignore_missing`` flag was added in Twig 1.18.3.
+
+The ``source`` function returns the content of a template without rendering it:
+
+.. code-block:: jinja
+
+    {{ source('template.html') }}
+    {{ source(some_var) }}
+
+When you set the ``ignore_missing`` flag, Twig will return an empty string if
+the template does not exist:
+
+.. code-block:: jinja
+
+    {{ source('template.html', ignore_missing = true) }}
+
+The function uses the same template loaders as the ones used to include
+templates. So, if you are using the filesystem loader, the templates are looked
+for in the paths defined by it.
+
+Arguments
+---------
+
+* ``name``: The name of the template to read
+* ``ignore_missing``: Whether to ignore missing templates or not