InputfieldSelect class

Base for selection form inputs, which by default behaves as a regular <select>

Serves as the base for Inputfields that provide selection of options (whether single or multi). As a result, this class includes functionality for, and checks for both single-and-multi selection values. Sublcasses will want to override the render method, but it's not necessary to override processInput(). Subclasses that select multiple values should implement the InputfieldHasArrayValue interface.

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.

Common
Properties

Common

Name	Return	Summary
InputfieldSelect::addOption() InputfieldSelect::addOption(string $value) InputfieldSelect::addOption(string $value, $label = null, array $attributes = null)	`$this`	Add an option that may be selected
InputfieldSelect::addOptionAttributes() InputfieldSelect::addOptionAttributes($key) InputfieldSelect::addOptionAttributes($key, array $attrs = [])	`$this`	Add attributes for an item (without removing existing attributes), or for multiple items
InputfieldSelect::addOptionLabel() InputfieldSelect::addOptionLabel($value, string $label) InputfieldSelect::addOptionLabel($value, string $label, $language = null)	`$this`	Add selectable option with label, optionally for specific language
InputfieldSelect::addOptions() InputfieldSelect::addOptions(array $options) InputfieldSelect::addOptions(array $options, bool $assoc = true)	`$this`	Add multiple options at once
InputfieldSelect::addOptionsString() InputfieldSelect::addOptionsString(string $value) InputfieldSelect::addOptionsString(string $value)	`$this`	Given a multi-line string, convert it to options, one per line
InputfieldSelect::get() InputfieldSelect::get(string $key) InputfieldSelect::get(string $key)	`array` `mixed` `null`	Get property
InputfieldSelect::getConfigInputfields() InputfieldSelect::getConfigInputfields() InputfieldSelect::getConfigInputfields()	`InputfieldWrapper`	Field configuration
InputfieldSelect::getOptionAttributes() InputfieldSelect::getOptionAttributes() InputfieldSelect::getOptionAttributes($key = null)	`array`	Get an attributes array intended for an item (or for all items)
InputfieldSelect::getOptionAttributesString() InputfieldSelect::getOptionAttributesString($key) InputfieldSelect::getOptionAttributesString($key)	`string`	Get an attributes string intended for the <option> element
InputfieldSelect::getOptions() InputfieldSelect::getOptions() InputfieldSelect::getOptions()	`array`	Get all options for this Select
InputfieldSelect::insertOptionsAfter() InputfieldSelect::insertOptionsAfter(array $options) InputfieldSelect::insertOptionsAfter(array $options, $existingValue = null)	`self`	Insert new options after an existing option
InputfieldSelect::insertOptionsBefore() InputfieldSelect::insertOptionsBefore(array $options) InputfieldSelect::insertOptionsBefore(array $options, $existingValue = null)	`self`	Insert new options before an existing option (or prepend options to beginning)
InputfieldSelect::isEmpty() InputfieldSelect::isEmpty() InputfieldSelect::isEmpty()	`bool`	Is the value empty?
InputfieldSelect::isOption() InputfieldSelect::isOption($value) InputfieldSelect::isOption($value, array $options = null)	`bool`	Returns whether the provided value is one of the available options
InputfieldSelect::isOptionDisabled() InputfieldSelect::isOptionDisabled($value) InputfieldSelect::isOptionDisabled($value)	`bool`	Is the given option value disabled?
InputfieldSelect::isOptionSelected() InputfieldSelect::isOptionSelected($value) InputfieldSelect::isOptionSelected($value)	`bool`	Returns whether the provided value is selected
InputfieldSelect::optionAttributes() InputfieldSelect::optionAttributes() InputfieldSelect::optionAttributes($key = null, $attributes = null, bool $append = false)	`array`	Get or set option attributes Can also be used as property: InputfieldSelect::optionAttributes
InputfieldSelect::optionLabel() InputfieldSelect::optionLabel($key) InputfieldSelect::optionLabel($key, $label = null)	`string` `bool`	Get or set label for given option value/key (default language)
InputfieldSelect::optionLanguageLabel() InputfieldSelect::optionLanguageLabel($language) InputfieldSelect::optionLanguageLabel($language, $key = null, $label = null)	`string` `array` `Inputfield`	Get or set alternative language label(s)
InputfieldSelect::processInput() InputfieldSelect::processInput(WireInputData $input) InputfieldSelect::processInput(WireInputData $input)	`$this`	Process input from the provided array
InputfieldSelect::removeOption() InputfieldSelect::removeOption($value) InputfieldSelect::removeOption($value)	`$this`	Remove the option with the given value
InputfieldSelect::render() InputfieldSelect::render() InputfieldSelect::render()	`string`	Render and return the output for this Select
InputfieldSelect::renderOptions() InputfieldSelect::renderOptions() InputfieldSelect::renderOptions($options = null, bool $allowBlank = true)	`string`	Render the given options
InputfieldSelect::renderReady() InputfieldSelect::renderReady() InputfieldSelect::renderReady($parent = null, bool $renderValueMode = false)	`bool`	Render ready
InputfieldSelect::renderValue() InputfieldSelect::renderValue() InputfieldSelect::renderValue()	`string`	Render non-editable value
InputfieldSelect::replaceOption() InputfieldSelect::replaceOption($oldValue, $newValue) InputfieldSelect::replaceOption($oldValue, $newValue, $newLabel = null, $newAttributes = null)	`bool`	Replace an option already present with the new value (and optionally new label and attributes)
InputfieldSelect::set() InputfieldSelect::set(string $key, mixed $value) InputfieldSelect::set(string $key, mixed $value)	`Inputfield` `InputfieldSelect`	Set property
InputfieldSelect::setAttribute() InputfieldSelect::setAttribute($key, $value) InputfieldSelect::setAttribute($key, $value)	`Inputfield` `InputfieldSelect`	Set attribute
InputfieldSelect::setOptionAttributes() InputfieldSelect::setOptionAttributes($key) InputfieldSelect::setOptionAttributes($key, array $attrs = [])	`$this`	Set/replace entire attributes array for an item
InputfieldSelect::setOptions() InputfieldSelect::setOptions(array $options) InputfieldSelect::setOptions(array $options, bool $assoc = true)	`$this`	Set/replace all options

Properties

Name	Return	Summary	Default
InputfieldSelect::defaultValue	`string` `int`
InputfieldSelect::options	`array` `string`	Get or set options, array of [value => label], or use options string.
InputfieldSelect::valueAddOption	`bool`	If value attr set from API (only) that is not an option, add it as an option? 3.0.171+	`false`

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