InputfieldSelect class

Selection of a single value from a select pulldown

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

Show class?             Show args?        

Common

NameReturnSummary 
addOption(string $value)
$thisAdd an option that may be selected 
addOptionAttributes($key)
$thisAdd attributes for an item (without removing existing attributes), or for multiple items 
addOptionLabel($value, string $label)
$thisAdd selectable option with label, optionally for specific language 
addOptions(array $options)
$thisAdd multiple options at once 
addOptionsString(string $value)
$thisGiven a multi-line string, convert it to options, one per line 
defaultValue string int 
get(string $key)
array mixed nullGet property 
getConfigInputfields()
InputfieldWrapperField configuration
getOptionAttributes()
arrayGet an attributes array intended for an item (or for all items) 
getOptionAttributesString($key)
stringGet an attributes string intended for the <option> element 
getOptions()
arrayGet all options for this Select 
insertOptionsAfter(array $options)
selfInsert new options after an existing option 
insertOptionsBefore(array $options)
selfInsert new options before an existing option (or prepend options to beginning) 
isEmpty()
boolIs the value empty? 
isOption($value)
boolReturns whether the provided value is one of the available options 
isOptionDisabled($value)
boolIs the given option value disabled? 
isOptionSelected($value)
boolReturns whether the provided value is selected 
optionAttributes()
arrayGet or set option attributes
Can also be used as property: optionAttributes 		 
optionLabel($key)
string boolGet or set label for given option value/key (default language) 
optionLanguageLabel($language)
string array InputfieldGet or set alternative language label(s) 
options array string Get or set options, array of [value => label], or use options string.  
processInput(WireInputData $input)
$thisProcess input from the provided array
removeOption($value)
$thisRemove the option with the given value 
render()
stringRender and return the output for this Select
renderOptions()
stringRender the given options 
renderReady()
boolRender ready 
renderValue()
stringRender non-editable value
replaceOption($oldValue, $newValue)
boolReplace an option already present with the new value (and optionally new label and attributes) 
set(string $key, mixed $value)
Inputfield InputfieldSelectSet property 
setAttribute($key, $value)
Inputfield InputfieldSelectSet attribute 
setOptionAttributes($key)
$thisSet/replace entire attributes array for an item 
setOptions(array $options)
$thisSet/replace all options 
valueAddOption bool If value attr set from API (only) that is not an option, add it as an option? (default=false) 3.0.171+ 

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.244

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits