Selector class

Selector maintains a single selector consisting of field name, operator, and value.

  • Serves as the base class for the different Selector types (SelectorEqual, SelectorNotEqual, SelectorLessThan, etc.)
  • The constructor requires $field and $value properties which may either be an array or string. An array indicates multiple items in an OR condition. Multiple items may also be specified by pipe “|” separated strings.
  • Operator is determined by the Selector class name, and thus may not be changed without replacing the entire Selector.
// very basic usage example
// constructor takes ($field, $value) which can be strings or arrays
$s = new SelectorEqual('title', 'About Us');
// $page can be any kind of Wire-derived object
if($s->matches($page)) {
  // $page has title "About Us"
}
// another usage example
$s = new SelectorContains('title|body|summary', 'foo|bar');
if($s->matches($page)) {
  // the title, body or summary properties of $page contain either the text "foo" or "bar"
}

List of core selector-derived classes

  • SelectorEqual
  • SelectorNotEqual
  • SelectorGreaterThan
  • SelectorLessThan
  • SelectorGreaterThanEqual
  • SelectorLessThanEqual
  • SelectorContains
  • SelectorContainsLike
  • SelectorContainsWords
  • SelectorContainsWordsPartial (3.0.160+)
  • SelectorContainsWordsLive (3.0.160)
  • SelectorContainsWordsLike (3.0.160)
  • SelectorContainsWordsExpand (3.0.160)
  • SelectorContainsAnyWords (3.0.160)
  • SelectorContainsAnyWordsPartial (3.0.160)
  • SelectorContainsAnyWordsLike (3.0.160)
  • SelectorContainsExpand (3.0.160)
  • SelectorContainsMatch (3.0.160)
  • SelectorContainsMatchExpand (3.0.160)
  • SelectorContainsAdvanced (3.0.160)
  • SelectorStarts
  • SelectorStartsLike
  • SelectorEnds
  • SelectorEndsLike
  • SelectorBitwiseAnd

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

Show class?             Show args?        

Common

NameReturnSummary 
Selector::field()
string array nullGet the field(s) of this Selector
Can also be used as property: Selector::field
 
Selector::fields()
arrayReturn array of field(s) for this Selector
Can also be used as property: Selector::fields
 
Selector::get(string $key)
array mixed null stringGet a property 
Selector::getCompareType()
intWhat type of comparson does Selector perform? 
Selector::getDescription()
stringGet longer description that describes this Selector 
Selector::getLabel()
stringGet short label that describes this Selector 
Selector::matches($value)
boolDoes this Selector match the given value? 
Selector::operator()
stringReturn the operator used by this Selector
Can also be used as property: Selector::operator
 
Selector::set(string $key, mixed $value)
Selector WireDataSet a property of the Selector 
Selector::setField($field)
selfSet field or fields 
Selector::setValue($value)
selfSet selector value(s) 
Selector::value()
string array nullGet the value(s) of this Selector
Can also be used as property: Selector::value
 
Selector::values()
arrayReturn array of value(s) for this Selector
Can also be used as property: Selector::values
 

Properties

NameReturnSummary 
Selector::forceMatch null bool When boolean, it forces match (true) or non-match (false). (default=null)  
Selector::group string null Group name for this selector (if field was prepended with a "group_name@").  
Selector::not bool Is this a NOT selector? Indicates the selector returns the opposite if what it would otherwise.  
Selector::quote string Type of quotes value was in, or blank if it was not quoted. One of: '"[{(  
Selector::str string String value of selector, i.e. “a=b”.  

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.160

Twitter updates

  • ProcessWire 3.0.161 adds support for selector operator stacking, enabling you automatically broaden searches in a single pages.find() call— More
    26 June 2020
  • ProcessWire 3.0.160 adds powerful new text-searching operators, bringing a new level of power to page-finding API calls, especially when it comes to search engine type queries. Post also includes a demo search engine where you can test it all out live— More
    19 June 2020
  • Preview of ProcessWire 3.0.160 with auto-enable of two-factor authentication, new version of TfaEmail and TfaTotp, and new selector operators coming next week. More
    12 June 2020

Latest news

  • ProcessWire Weekly #320
    In the 320th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.161), a new third party module called Fieldtype Runtime only, an IndieWeb themed article from Francesco Schwarz, and more. Read on!
    Weekly.pw / 27 June 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH