geckon01/Twig
1
0
Fork 0
mirror of https://github.com/twigphp/Twig.git synced 2026-09-13 02:46:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

minor #4694 [Doc] Tweaks in the escaping article (javiereguiluz)

Browse Source 
This PR was merged into the 3.x branch.

Discussion
----------

[Doc] Tweaks in the escaping article

AS you can see in the redenred page (https://twig.symfony.com/doc/3.x/filters/escape.html) the tip about `html_attr` contains some uneeded line breaks.

This also tweaks another explanation to make it more clear.

Commits
-------

50327b5019 [Doc] Tweaks in the escaping article
This commit is contained in:
Fabien Potencier
2025-09-25 12:20:18 +02:00
parent dac599c320 50327b5019
commit a895a3f00d
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/filters/escape.rst
+9 -9
View File
@@ -53,8 +53,9 @@ documents:
* ``url``: escapes a string for the **URI or parameter** contexts. This should
not be used to escape an entire URI; only a subcomponent being inserted.
* ``html_attr``: escapes a string for the **HTML attribute** context,
**without quotes** around HTML attribute values.
* ``html_attr``: escapes a string when used as an **HTML attribute** name, and
also when used as the value of an HTML attribute **without quotes**
(e.g. ``data-attribute={{ some_value }}``).
Note that doing contextual escaping in HTML documents is hard and choosing the
right escaping strategy depends on a lot of factors. Please, read related
@@ -96,23 +97,22 @@ to learn more about this topic.
.. tip::
The ``html_attr`` escaping strategy can be useful when you need to
escape a **dynamic HTML attribute name**:
The ``html_attr`` escaping strategy can be useful when you need to escape a
**dynamic HTML attribute name**:
.. code-block:: html+twig
<p {{ your_html_attr|e('html_attr') }}="attribute value">
It can also be used for escaping a **dynamic HTML attribute value**
if it is not quoted, but this is **less performant**.
Instead, it is recommended to quote the HTML attribute value and use
the ``html`` escaping strategy:
It can also be used for escaping a **dynamic HTML attribute value** if it is
not quoted, but this is **less performant**. Instead, it is recommended to
quote the HTML attribute value and use the ``html`` escaping strategy:
.. code-block:: html+twig
<p data-content="{{ content|e('html') }}">
{# is equivalent to, but is less performant #}
{# this is equivalent, but less performant #}
<p data-content={{ content|e('html_attr') }}>
Custom Escapers