escape.md

layout	title
page	Filters › escape

← filters

Filter escape(strategy):

• strategy: The escaping strategy. By default is html.

---

The escape filter escapes a string using strategies that depend on the context.

By default, it uses the HTML escaping strategy:

<p>
    {{ user.username|escape }}
</p>

For convenience, the e filter is defined as an alias:

<p>
    {{ user.username|e }}
</p>

The escape filter can also be used in other contexts than HTML thanks to an optional argument which defines the escaping strategy to use:

{{ user.username|e }}
{# is equivalent to #}
{{ user.username|e('html') }}

And here is how to escape variables included in JavaScript code:

{{ user.username|escape('js') }}
{{ user.username|e('js') }}

The escape filter supports the following escaping strategies for HTML documents:

• html: escapes a string for the HTML body context.
• js: escapes a string for the JavaScript context.
• 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.

Also you cat add your custom escaper.

Built-in escapers cannot be overridden mainly because they should be considered as the final implementation and also for better performance.