InputfieldSelect

isOption($value)

Returns true if the given value is a valid option (including within optgroups). Separator values are never considered valid options.

if($f->isOption('red')) {
 // 'red' is available
}

isOptionSelected($value)

Returns true if the given option value is currently selected.

if($f->isOptionSelected('green')) { ... }

isOptionDisabled($value)

Returns true if the given option value has the disabled attribute set.

if($f->isOptionDisabled('tbd')) { ... }

optionLabel($key, $label = null)

Get or set the label for a given option value (default language).

// get label
$label = $f->optionLabel('red'); // 'Red'
// set label
$f->optionLabel('red', 'Dark red');

Returns the label string, or false if the option is not found.

addOptionLabel($value, $label, $language = null)

Add a translated label for an option value in a specific language 3.0.176+. If specified, $language can be a Language object, name or ID.

$f->addOptionLabel('red', 'Rojo', 'es');

optionLanguageLabel($language, $key = null, $label = null)

Low-level get/set for language-specific option labels. Accepts Language object, ID, or name string.

// set one label
$f->optionLanguageLabel('es', 'red', 'Rojo');
// set multiple labels for a language at once
$f->optionLanguageLabel('es', ['red' => 'Rojo', 'green' => 'Verde']);
// get all labels for a language
$labels = $f->optionLanguageLabel('es');
// remove all labels for a language
$f->optionLanguageLabel('es', false);

optionAttributes($key = null, $attributes = null, $append = false)

Combined get/set for option attributes. Without arguments, returns all option attributes. With $key only, returns attributes for that option. With $attributes array, sets (or appends) attributes for that option.

// get all option attributes
$all = $f->optionAttributes();
// get attributes for one option
$attrs = $f->optionAttributes('red'); // e.g. ['disabled' => 'disabled']
// set attributes for one option
$f->optionAttributes('red', ['class' => 'highlight']);
// append attributes (merge, don't replace)
$f->optionAttributes('red', ['data-hex' => '#ff0000'], true);

setOptionAttributes($key, array $attrs)

Set (replace) the entire attributes array for an option. Pass an associative array as $key to replace ALL option attributes at once.

addOptionAttributes($key, array $attrs)

Merge attributes into an option's existing attributes without replacing them.

getOptionAttributes($key = null)

Get attributes for a specific option, or all option attributes if $key is omitted.

Default value

When defaultValue is set and the field is required and currently empty, the default value is applied automatically during render() and after processInput().

$f->required = true;
$f->defaultValue = 'green';
// if no value is selected, 'green' is used

valueAddOption

When valueAddOption is true, setting a value via the API that is not already a defined option automatically adds it as an option. Applies only to values set from code — not to user-submitted input (security).

$f->valueAddOption = true;
$f->val('purple'); // 'purple' is added as an option and selected

isEmpty()

Returns true when no option is selected. The value '0' is considered empty only when '0' is not a defined option.

if($f->isEmpty()) {
 // nothing selected
}

processInput() validates all submitted values against the defined options list and silently removes any that are not present. This prevents injection of arbitrary values through manipulated form submissions.

• Value is always an array. Use $f->val(['a', 'b']) to set multiple selections.
• Blank options are silently ignored — multi-select has no concept of a "blank" selection.
• Implements InputfieldHasArrayValue. After processInput(), $f->val() returns an array of selected values.
• Source file: wire/modules/Inputfield/InputfieldSelectMultiple.module