$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.200

Twitter updates

  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022
  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull