$sanitizer->selectorValueAdvanced() method

Sanitize selector value for advanced text search operator (#=)

The advanced text search operator #= supports some characters that are typically excluded from selector values, so this method enables you to prepare a selector value for use with it. This method should not be used for sanitizing any other kinds of selector values.

Characters that have meaning to the advanced text search operator include +-*()" and thus their appearance in the $value argument is assumed to be a command rather than text to search for. Though note that non-matching double quotes or parenthesis are removed.

Note: If double quotes are used in your selector value, this method will convert them to matching parenthesis, i.e. +"phrase" gets converted to +(phrase).

Available since version 3.0.182.

Usage

// basic usage
$bool = $sanitizer->selectorValueAdvanced($value);

// usage with all arguments
$bool = $sanitizer->selectorValueAdvanced($value, array $options = []);

Arguments

NameType(s)Description
valuestring, array
options (optional)array

See options for Sanitizer::selectorValue() method

Return value

bool mixed string

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #519
    In the 519th issue of ProcessWire Weekly we'll check out a new third party module called RockForms, introduce the latest ProcessWire core updates, and more. Read on!
    Weekly.pw / 20 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani