$sanitizer->entities() method

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

NameType(s)Description
strstring

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

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #560
    In the 560th issue of ProcessWire Weekly we'll check out the latest core updates, cover newly released ProcessWire modules, and more. Read on!
    Weekly.pw / 1 February 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer