UsergrouplistField

Extends JFormFieldList

Field to load a dropdown list of available user groups

since

3.2

package

Joomla CMS

Methods

getOptions

Method to get the options to populate list

getOptions() : array
since

3.2

Response

arrayThe field option objects.

setup

Method to attach a JForm object to the field.

setup(\SimpleXMLElement element, mixed value, string group = null) : bool
since

1.7.0

Arguments

element

\SimpleXMLElementThe SimpleXMLElement object representing the <field> tag for the form field object.

value

mixedThe form field value to validate.

group

stringThe field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".

Response

boolTrue on success.

Properties

type

The form field type.

since

3.2

Type(s)

string

options

Cached array of the category items.

static
since

3.2

Type(s)

array