ibexa

Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.

wash

Summary

Returns an HTML-safe version of the input string.

Usage

input|wash( [type] )

Parameters

NameTypeDescriptionRequired
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 "xhtml"). 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 <'|wash()}
The following output will be produced: "Bogus & stuff <".

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".

Balazs Halasy (05/02/2004 11:02 am)

Geir Arne Waaler (23/04/2010 7:47 am)

Balazs Halasy, Geir Arne Waaler


Comments

  • Additional parameters "javascript" & "pdf"

    The wash operator will also take "javascript" & "pdf" as parameter