API16:JHtmlSelect/optgroup

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Create a placeholder for an option group.

<! removed transcluded page call, red link never existed >

Syntax

static optgroup($text, $optKey= 'value', $optText= 'text')

Parameter Name	Default Value	Description
$text		The text for the option
$optKey	'value'	The returned object property name for the value
$optText	'text'	The returned object property name for the text

Returns

object

Defined in

libraries/joomla/html/html/select.php

Importing

jimport( 'joomla.html.html.select' );

Source Body

public static function optgroup($text, $optKey = 'value', $optText = 'text')
{
        $obj = new stdClass;
        $obj->$optKey = '<OPTGROUP>';
        $obj->$optText = $text;
        return $obj;
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />