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.236

Latest news

  • ProcessWire Weekly #524
    In the 524th issue of ProcessWire Weekly we'll check out what's new in the core this week, introduce a new module called SEO Text Width, and more. Read on!
    Weekly.pw / 25 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull