API17:JHtmlSelect::option
From Joomla! Documentation
JHtmlSelect::option
Description
Create an object that represents an option in an option list.
public static function option (
$value
$text= ''
$optKey= 'value'
$optText= 'text'
$disable=false
)
| Parameter | Type | Default | Description |
|---|---|---|---|
| $value | string | The value of the option | |
| $text | string | The text for the option | |
| $optKey | array | 'value' | array. Additional attributes for this option. Defaults to none. disable: Boolean. If set, this option is disabled. label: String. The value for the option label. option.attr: The property in each option array to use for additional selection attributes. Defaults to none. option.disable: The property that will hold the disabled state. Defaults to "disable". option.key: The property that will hold the selection value. Defaults to "value". option.label: The property in each option array to use as the selection label attribute. If a "label" option is provided, defaults to "label", if no label is given, defaults to null (none). option.text: The property that will hold the the displayed text. Defaults to "text". If set to null, the option array is assumed to be a list of displayable scalars. |
| $optText | string | 'text' | The property that will hold the the displayed text. This parameter is ignored if an options array is passed. |
| $disable | false |
- Returns object
- Defined on line 400 of libraries/joomla/html/html/select.php
See also
JHtmlSelect::option source code on BitBucket
Class JHtmlSelect
Subpackage Html- Other versions of JHtmlSelect::option
User contributed notes
Code Examples