wash

Summary

Returns an HTML-safe version of the input string.

Usage

input|wash( [type] )

Parameters

Name	Type	Description	Required
type	string	The type of text that should be washed.	No.

Returns

An HTML-safe version of the input string.

Description

This operator translates the input string into an HTML friendly version. It will take care of converting bogus characters to HTML-friendly replacements. The "type" parameter can be used to specify the washing type, it can be set to either "xhtml" or "email" (the default is "xthml"). E-mail washing can be controlled using the setting of the [WashSettings] configuration block of "template.ini". All strings that may break the HTML should always be washed using this operator.

Examples

Example 1

{'Bogus & stuff &lt;'|wash()}
The following output will be produced: "Bogus &amp; stuff &lt;".

Example 2

{'hello@example.com'|wash( 'email' )}

The following output will be produced:

hello<span class="spamfilter">SPAMFILTER</span>@example.com

Example 3

{'hello@example.com'|wash( 'email' )}

If a configuration override for "template.ini" exists and contains...

[WashSettings]
EmailDotText=[dot]
EmailAtText=[at]

...the following output will be produced: "hello[at]example[dot]com".

This document is based on eZ Publish Documentation. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License.