Edit on GitHub
Jump to docs navigation

Twig Components / Methods / autoescape

Note: You are currently reading the documentation for Bolt 5.0. Looking for the documentation for Bolt 5.2 instead?

autoescape is a Twig tag to, whether automatic escaping is enabled or not, mark a section of a template to be escaped or not by using the autoescape tag:

{% autoescape %}
    Everything will be automatically escaped in this block using the HTML strategy
{% endautoescape %}
{% autoescape 'html' %}
    Everything will be automatically escaped in this block using the HTML strategy
{% endautoescape %}
{% autoescape 'js' %}
    Everything will be automatically escaped in this block using the js escaping strategy
{% endautoescape %}
{% autoescape false %}
    Everything will be outputted as is in this block
{% endautoescape %}

When automatic escaping is enabled everything is escaped by default except for values explicitly marked as safe. Those can be marked in the template by using the raw filter:

{% autoescape %}
    {{ safe_value|raw }}
{% endautoescape %}

Functions returning template data (like macros and parent) always return safe markup.

Note

Twig is smart enough to not escape an already escaped value by the escape filter.

Note

Twig does not escape static expressions:

{% set hello = <strong>Hello<strong> %}
{{ hello }}
{{ "<strong>world<strong>" }}

Will be rendered "<strong>Hello</strong> world".

Note

The chapter Twig for Developers gives more information about when and how automatic escaping is applied.

Source: Twig



Edit this page on GitHub
Couldn't find what you were looking for? We are happy to help you in the forum, on Slack or on Github.