Selectors class

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.

Show class?             Show args?        

Advanced

Static helpers

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

NameReturnSummary 
Selectors::arrayToKeyValueString(array $a)
stringGiven an assoc array, convert to a key=value selector-style string 
Selectors::getOperatorChars()
arrayReturn array of all valid operator characters 
Selectors::getOperatorType(string $operator)
bool stringReturn a string indicating the type of operator that it is, or false if not an operator 
Selectors::getOperators()
array string intGet all operators allowed by selectors 
Selectors::getReservedChars()
arrayReturn array of other characters that have meaning in a selector outside of operators 
Selectors::getSelectorByOperator(string $operator)
Selector int string falseGiven an operator, return Selector instance (or other requested Selector property) 
Selectors::isOperator(string $operator)
bool stringReturns true if given string is a recognized operator, or false if not 
Selectors::keyValueStringToArray(string $s)
arraySimple "a=b, c=d" selector-style string conversion to associative array, for fast/simple needs 
Selectors::selectorHasField($selectors, $fieldName)
array boolDoes given selector have given field (and optionally operator and/or value)? 
Selectors::stringHasOperator(string $str)
boolDoes the given string have an operator in it? 
Selectors::stringHasSelector(string $str)
boolIs the given 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.178

Twitter updates

  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021
  • ProcessWire updates for week of 21 May 2021— More
    22 May 2021

Latest news

  • ProcessWire Weekly #370
    In the 370th issue of ProcessWire Weekly we're going to check out the latest version of the commercial FormBuilder module, introduce a couple of brand new third party modules, and more. Read on!
    Weekly.pw / 12 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • 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