Processes a selector string into a WireArray of Selector objects.

This Selectors class is used internally by ProcessWire to provide selector string (and array) matching throughout the core.

$selectors = new Selectors("sale_price|retail_price>100, currency=USD|EUR");
if($selectors->matches($page)) {
  // selector string matches the given $page (which can be any Wire-derived item)
// iterate and display what's in this Selectors object
foreach($selectors as $selector) {
  echo "<p>";
  echo "Field(s): " . implode('|', $selector->fields) . "<br>";
  echo "Operator: " . $selector->operator . "<br>";
  echo "Value(s): " . implode('|', $selector->values) . "<br>";
  echo "</p>";

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Selectors class also inherits all the methods and properties of: WireArray and Wire.

Common / Advanced / Static helpers

Show “Selectors”             Show Arguments        


arrayReturn array of all field names referenced in all of the Selector objects here
arrayReturn array of all values referenced in all Selector objects here
Selectors::getOperatorType(string $operator)
bool or stringReturn a string indicating the type of operator that it is, or false if not an operator
Selectors::getSelectorByField(string $fieldName)
Selector, array or nullGet the first selector that uses given field name
(nothing)Set the selector string or array (if not set already from the constructor)
Selectors::isOperator(string $operator)
boolReturns true if given string is a recognized operator, or false if not
Selectors::matches(Wire $item)
boolDoes the given Wire match these Selectors?


Selectors::create(string $field, string $operator, string $value)
SelectorCreate a new Selector object from a field name, operator, and value

Static helpers

Static helper methods useful in analyzing selector strings outside of this class.

stringGiven an assoc array, convert to a key=value selector-style string
arrayReturn array of all valid operator characters
Selectors::keyValueStringToArray(string $s)
arraySimple "a=b, c=d" selector-style string conversion to associative array, for fast/simple needs
Selectors::stringHasOperator(string $str)
boolDoes the given string have an operator in it?
Selectors::stringHasSelector(string $str)
boolIs the give string a Selector string?

Additional methods and properties

In addition to the methods and properties above, Selectors also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.115