$sanitizer->unentities() method

Remove entity encoded characters from a string.

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

The arguments used here are identical to those for PHP’s (except $flags can be boolean true):
html_entity_decode function.

For the $flags argument, specify boolean true if you want to perform a more comprehensive entity decode than what PHP does. That will make it convert all UTF-8 entities (including decimal and hex numbered entities), and it will remove any remaining entity sequences if the could not be converted, ensuring there are no entities possible in returned value.

Usage

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

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

Arguments

NameType(s)Description
strstring

String to remove entities from

flags (optional)int, bool

See PHP html_entity_decode function for flags, OR specify boolean true to convert all entities and remove any that cannot be converted (since 3.0.105).

encoding (optional)string

Encoding (default="UTF-8").

Return value

string

String with entities removed.

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.161

Twitter updates

  • ProcessWire 3.0.162 continues improvements to selector operators, fixes various minor issues, adds new API convenience methods, improves documentation, optimizes and refactors various portions of code and DB queries, and more— More
    10 July 2020
  • New dedicated page in our online documentation for Selector Operators: More
    10 July 2020
  • New ProcessWire query expansion search operators can now add automatic word inflections and lemmatisation, enabling you to build even smarter search engines with ProcessWire. More
    3 July 2020

Latest news

  • ProcessWire Weekly #321
    In the 321st issue of ProcessWire Weekly we're going to check out the latest core updates, introduce two new third party modules, and check out a brand new site of the week. Read on!
    Weekly.pw / 4 July 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer