$sanitizer→entities()

Entity encode a string for output

Wrapper for PHP's htmlentities() function that contains typical ProcessWire usage defaults

The arguments used here are identical to those for PHP's htmlentities function, except that the ProcessWire defaults for encoding quotes and using UTF-8 are already populated.

Example

$test = "ain't <em>nothing</em> perfect but our brokenness";
echo $sanitizer->entities($test);
// result: ain&apos;t &lt;em&gt;nothing&lt;/em&gt; perfect but our brokenness

Usage

// basic usage
$string = $sanitizer->entities(string $str);

// usage with all arguments
$string = $sanitizer->entities(string $str, $flags = 3, string $encoding = 'UTF-8', bool $doubleEncode = true);

Arguments

Name	Type(s)	Description
`$str`	`string`	String to entity encode
`$flags` (optional)	`int` `bool`	See PHP htmlentities() function for flags.
`$encoding` (optional)	`string`	Encoding of string Default:"UTF-8"
`$doubleEncode` (optional)	`bool`	Allow double encode? Default:true

Return value

string

Entity encoded string