|
$options |
array |
the tag options in terms of name-value pairs. The following options are specially handled:
- prompt: string, a prompt text to be displayed as the first option. Since version 2.0.11 you can use an array
to override the value and to set other tag attributes:
```php
['text' => 'Please select', 'options' => ['value' => 'none', 'class' => 'prompt', 'label' => 'Select']],
```
- options: array, the attributes for the select option tags. The array keys must be valid option values,
and the array values are the extra attributes for the corresponding option tags. For example,
```php
[
'value1' => ['disabled' => true],
'value2' => ['label' => 'value 2'],
];
```
- groups: array, the attributes for the optgroup tags. The structure of this is similar to that of 'options',
except that the array keys represent the optgroup labels specified in $items.
- unselect: string, the value that will be submitted when no option is selected.
When this attribute is set, a hidden field will be generated so that if no option is selected in multiple
mode, we can still obtain the posted unselect value.
- encodeSpaces: bool, whether to encode spaces in option prompt and option value with ` ` character.
Defaults to false.
- encode: bool, whether to encode option prompt and option value characters.
Defaults to `true`. This option is available since 2.0.3.
The rest of the options will be rendered as the attributes of the resulting tag. The values will
be HTML-encoded using [[encode()]]. If a value is null, the corresponding attribute will not be rendered.
See [[renderTagAttributes()]] for details on how attributes are being rendered. |
