Selectors::getSelectorByField() method

Get the first selector that uses given field name

This is useful for quickly retrieving values of reserved properties like "include", "limit", "start", etc.

Using $or: By default this excludes selectors that have fields in an OR expression, like "a|b|c". So if you specified field "a" it would not be matched. If you wanted it to still match, specify true for the $or argument.

Using $all: By default only the first matching selector is returned. If you want it to return all matching selectors in an array, then specify true for the $all argument. This changes the return value to always be an array of Selector objects, or a blank array if no match.

Usage

// basic usage
$selector = $selectors->getSelectorByField(string $fieldName);

// usage with all arguments
$selector = $selectors->getSelectorByField(string $fieldName, bool $or = false, bool $all = false);

Arguments

NameType(s)Description
fieldNamestring

Name of field to return value for (i.e. "include", "limit", etc.)

or (optional)bool

Allow fields that appear in OR expressions? (default=false)

all (optional)bool

Return an array of all matching Selector objects? (default=false)

Return value

Selector array null

Returns null if field not present in selectors (or blank array if $all mode)


Selectors methods and properties

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • 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