MarkupHTMLPurifier::get() method

Get an HTMLPurifier config option

  • If the given $key is an object, it will cast it to a string.
  • If the given $key is a string with "|" pipe characters in it, it will try all till it finds a non-empty value.
  • If given an API variable name, it will return that API variable unless the class has direct access API variables disabled.

Example

// Retrieve the value of a property
$value = $item->get("some_property");

// Retrieve the value of the first non-empty property:
$value = $item->get("property1|property2|property2");

// Retrieve a value using array access
$value = $item["some_property"];

Usage

$string = $markupHTMLPurifier->get(string $key);

Arguments

NameType(s)Description
keystring

Name of property you want to retrieve.

Return value

string null

Returns value of requested property, or null if the property was not found.

See Also


MarkupHTMLPurifier methods and properties

API reference based on ProcessWire core version 3.0.244

“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