Selectors::getSelectorByFieldValue() method

Get the first selector that uses given field name AND has the given value

Using $or: By default this excludes selectors that have fields or values 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.

Available since version 3.0.142.

Usage

// basic usage
$selector = $selectors->getSelectorByFieldValue(string $fieldName, $value);

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

Arguments

NameType(s)Description
fieldNamestring

Name of field to match

valuestring, int

Value that must match

or (optional)bool

Allow fields and values 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.172

Twitter updates

  • This week ProcessWire (3.0.175) gained the ability to maintain separate read-only and read-write database connections to optimize scalability, cost and performance. The post covers why this can be so valuable and how to configure it in ProcessWire— More
    2 April 2021
  • ProcessWire 3.0.174 core updates: improvements to the new path/URL hooks and more— More
    12 March 2021
  • ProcessWire 3.0.173 adds several new requested features and this post focuses on one of my favorites: the ability to hook into and handle ProcessWire URLs, independent of pages— More
    5 March 2021

Latest news

  • ProcessWire Weekly #361
    In the 361st issue of ProcessWire Weekly we'll take  closer look at a new third party module called Copy Markdown, and check out the latest weekly update from Ryan. Read on!
    Weekly.pw / 10 April 2021
  • ProcessWire 3.0.175 adds new database scalability options
    This week ProcessWire gained the ability to maintain separate read-only and read-write database connections to optimize scalability, cost and performance. The post covers why this can be so valuable and how to configure it in ProcessWire.
    Blog / 2 April 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK