www.aleph1.co.uk Git - yaffs-website/blob - vendor/twig/twig/doc/filters/default.rst

   1 ``default``
   2 ===========
   3
   4 The ``default`` filter returns the passed default value if the value is
   5 undefined or empty, otherwise the value of the variable:
   6
   7 .. code-block:: jinja
   8
   9     {{ var|default('var is not defined') }}
  10
  11     {{ var.foo|default('foo item on var is not defined') }}
  12
  13     {{ var['foo']|default('foo item on var is not defined') }}
  14
  15     {{ ''|default('passed var is empty')  }}
  16
  17 When using the ``default`` filter on an expression that uses variables in some
  18 method calls, be sure to use the ``default`` filter whenever a variable can be
  19 undefined:
  20
  21 .. code-block:: jinja
  22
  23     {{ var.method(foo|default('foo'))|default('foo') }}
  24
  25 .. note::
  26
  27     Read the documentation for the :doc:`defined<../tests/defined>` and
  28     :doc:`empty<../tests/empty>` tests to learn more about their semantics.
  29
  30 Arguments
  31 ---------
  32
  33 * ``default``: The default value