[Doc] Update the docs about attribute() function

This commit is contained in:
Javier Eguiluz
2024-12-18 15:17:51 +01:00
committed by Fabien Potencier
parent d78cb00f89
commit 84daad9a27
+17 -8
View File
@@ -3,21 +3,30 @@
.. warning::
The ``attribute`` filter is deprecated as of Twig 3.15. Use the
The ``attribute`` function is deprecated as of Twig 3.15. Use the
:ref:`dot operator <dot_operator>` that now accepts any expression
when wrapped with parenthesis.
Note that this filter will still be available in Twig 4.0 to allow a
Note that this function will still be available in Twig 4.0 to allow a
smoother upgrade path.
The ``attribute`` function can be used to access a "dynamic" attribute of a
variable:
The ``attribute`` function lets you access an attribute, method, or property of
an object or array when the name of that attribute, method, or property is stored
in a variable or dynamically generated with an expression:
.. code-block:: twig
{{ attribute(object, method) }}
{{ attribute(object, method, arguments) }}
{{ attribute(array, item) }}
{# method_name is a variable that stores the method to call #}
{{ attribute(object, method_name) }}
{# you can also pass arguments when calling a method #}
{{ attribute(object, method_name, arguments) }}
{# the method/property name can be the result of evaluating an expression #}
{{ attribute(object, 'some_property_' ~ user.type) }}
{# in addition to objects, this function works with plain arrays as well #}
{{ attribute(array, item_name) }}
In addition, the ``defined`` test can check for the existence of a dynamic
attribute:
@@ -29,7 +38,7 @@ attribute:
.. note::
The resolution algorithm is the same as the one used for the ``.``
operator, except that the item can be any valid expression.
operator.
Arguments
---------