$sanitizer->entitiesA() method

Entity encode with support for [A]rrays and other non-string values

This is similar to the existing entities() method with the following differences:

  • Array values that are strings are encoded recursively to any depth and array is returned.
  • Associative array keys (strings) are entity encoded, integer keys are left as-is.
  • Objects that implement __toString() are converted to string and entity encoded.
  • Objects that do not implement __toString() are converted to a class name.
  • If given an int, float, bool, array or string, that is also the type returned.

Available since version 3.0.194.

Usage

// basic usage
$array = $sanitizer->entitiesA($value);

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

Arguments

NameType(s)Description
valuearray, string, int, float, object, bool
flags (optional)int
encoding (optional)string
doubleEncode (optional)bool

Return value

array string int float bool

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 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