SelectableOptionArray class

Located in file /wire/modules/Fieldtype/FieldtypeOptions/SelectableOptionArray.php

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

Show class?             Show args?        

Common

NameReturnSummary 
SelectableOptionArray::getField()
null FieldReturns Field object these options are for 
SelectableOptionArray::getItemKey($item)
(nothing) 
SelectableOptionArray::getPage()
NullPage PageReturns page these options are for, if applicable (NullPage otherwise) 
SelectableOptionArray::getProperty(string $property)
mixed nullEnables this WireArray to behave like the first item (for getting properties) 
SelectableOptionArray::hasID(int $id)
SelectableOption boolIs the given id present in these selectable options? 
SelectableOptionArray::hasTitle(string $title)
SelectableOption boolIs the given title present in these selectable options? 
SelectableOptionArray::hasValue(string $value)
SelectableOption boolIs the given value present in these selectable options? 
SelectableOptionArray::id int 
SelectableOptionArray::isIdentical(WireArray $items)
boolIs the given WireArray identical to this one? 
SelectableOptionArray::isValidItem($item)
boolIs the given item valid for storange in this array? 
SelectableOptionArray::isValidKey($key)
boolIs the given item key valid for use in this array? 
SelectableOptionArray::makeBlankItem()
(nothing) 
SelectableOptionArray::of()
boolGet or set output formatting mode 
SelectableOptionArray::render()
stringProvide a default string rendering of these selectable options 
SelectableOptionArray::set($key, $value)
$thisSet an item by key in the WireArray. 
SelectableOptionArray::setField(Field $field)
(nothing)Set the field these options are for 
SelectableOptionArray::setPage(Page $page)
(nothing)Set the these options live on 
SelectableOptionArray::setProperty(string $property, mixed $value)
SelectableOption SelectableOptionArrayEnables this WireArray to behave like the first item (for setting properties) 
SelectableOptionArray::title string 
SelectableOptionArray::value string 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #551
    In the 551st issue of ProcessWire Weekly we'll check out what's new in the core this week, share a new weekly poll, and more. Read on!
    Weekly.pw / 1 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani