Skip to main content
Version: 0.6

Template filters

This page provides a reference for all the available filters that can be used when defining templates.

capitalize​

The capitalize filter allows to modify a string so that the first letter is converted to uppercase and all the subsequent letters are converted to lowercase.

For example:

{{ value|capitalize }}

If value is "marten", the output will be "Marten".

default​

The default filter allows to fallback to a specific value if the left side of the filter expression is empty or not truthy. A filter argument is mandatory. It should be noted that empty strings are considered truthy and will be returned by this filter.

For example:

{{ value|default:"foobar" }}

If value is nil (or 0 or false), the output will be "foobar".

downcase​

The downcase filter allows to convert a string so that each of its characters is lowercase.

For example:

{{ value|downcase }}

If value is "Hello", then the output will be "hello".

escape​

The escape filter replaces special characters (namely &, <, >, " and ') in the template variable with their corresponding HTML entities.

For example:

{{ value|escape }}

If value is <b>Let's do it</b>, then the output will be &lt;b&gt;Let&#39;s do it&lt;/b&gt;.

join​

The join filter converts an array of elements into a string separated by arg.

For example:

{{ value|join: arg }}

If value is ["Bananas","Apples","Oranges"] and arg is , , then the output will be "Bananas, Apples, Oranges".

linebreaks​

The linebreaks filter allows to convert a string replacing all newlines with HTML line breaks (<br />).

For example:

{{ value|linebreaks }}

If value is Hello\nWorld, then the output will be Hello<br />World.

safe​

The safe filter allows to mark that a string is safe and that it should not be escaped before being inserted in the final output of a rendered template. Indeed, string values are always automatically HTML-escaped by default in templates.

For example:

{{ value|safe }}

If value is <p>Hello</p>, then the output will be <p>Hello</p> as well.

size​

The size filter allows returning the size of a string or an enumerable object.

For example:

{{ value|size }}

split​

The split filter converts a string into an array of elements separated by arg.

For example:

{{ value|split: arg }}

If value is Bananas,Apples,Oranges and arg is ,, then the output will be ["Bananas","Apples","Oranges"].

time​

The time filter allows outputting the string representation of a time variable. It requires the specification of a filter argument, which is the format string used to format the time (whose available directives are part of Time::Format).

{{ value | time: "%Y-%m-%d" }}

In the above example, the output will be a date string such as 2023-09-25.

underscore​

The underscore filter allows to convert a string to its underscored version.

For example:

{{ value|underscore }}

If value is "FooBar", then the output will be "foo_bar".

upcase​

The upcase filter allows to convert a string so that each of its characters is uppercase.

For example:

{{ value|upcase }}

If value is "Hello", then the output will be "HELLO".