Gecko [ www.finalhopeacademy.com ]

Name	Size	Permission
attribute.rst	604 B	-rw-r--r--
block.rst	789 B	-rw-r--r--
constant.rst	487 B	-rw-r--r--
cycle.rst	548 B	-rw-r--r--
date.rst	1.04 KB	-rw-r--r--
dump.rst	1.54 KB	-rw-r--r--
include.rst	2.24 KB	-rw-r--r--
index.rst	213 B	-rw-r--r--
max.rst	332 B	-rw-r--r--
min.rst	331 B	-rw-r--r--
parent.rst	563 B	-rw-r--r--
random.rst	703 B	-rw-r--r--
range.rst	1.19 KB	-rw-r--r--
source.rst	694 B	-rw-r--r--
template_from_string.rst	867 B	-rw-r--r--

Code Editor : dump.rst

``dump``
========

The ``dump`` function dumps information about a template variable. This is
mostly useful to debug a template that does not behave as expected by
introspecting its variables:

.. code-block:: jinja

.. note::

The ``dump`` function is not available by default. You must add the
    ``Twig_Extension_Debug`` extension explicitly when creating your Twig
    environment::

$twig = new Twig_Environment($loader, array(
            'debug' => true,
            // ...
        ));
        $twig->addExtension(new Twig_Extension_Debug());

Even when enabled, the ``dump`` function won't display anything if the
    ``debug`` option on the environment is not enabled (to avoid leaking debug
    information on a production server).

In an HTML context, wrap the output with a ``pre`` tag to make it easier to
read:

.. code-block:: jinja

.. tip::

Using a ``pre`` tag is not needed when `XDebug`_ is enabled and
    ``html_errors`` is ``on``; as a bonus, the output is also nicer with
    XDebug enabled.

You can debug several variables by passing them as additional arguments:

.. code-block:: jinja

If you don't pass any value, all variables from the current context are
dumped:

.. code-block:: jinja

.. note::

Internally, Twig uses the PHP `var_dump`_ function.

Arguments
---------

* ``context``: The context to dump

.. _`XDebug`:   http://xdebug.org/docs/display
.. _`var_dump`: http://php.net/var_dump

${this.title}

Code Editor : dump.rst