Skip to main content
Version: 5.2 (Current)

Usergrouplist Form Field

The usergrouplist form field type provides a dropdown select box of user groups.

  • type (mandatory) must be usergrouplist.
  • name (mandatory) is the unique name of the field.
  • label (mandatory) (translatable) is the field html label.
  • description (optional) (translatable) is the field description.
  • default (optional) (not translatable) is the usergroup id of the default selection in the dropdown list.
  • layout (optional) (translatable) is the layout, for example joomla.form.field.list-fancy-select.
  • checksuperusergroup (optional) is boolean to omit Super User groups. Values 1 or 0.
  • multiple (optional) If set to true then allows more than one usergroup to be selected.

Implemented by: libraries/src/Form/Field/UsergrouplistField.php

Example XML parameter definition​

<field
        name="usergroup"
        type="UserGroupList"
        label="MOD_EXAMPLE_USERGROUP_LABEL"
        description="MOD_EXAMPLE_USERGROUP_DESC"
        layout="joomla.form.field.list-fancy-select"
        checksuperusergroup="1"
        default=""
        multiple="0"
        >
        <option value="0">MOD_EXAMPLE_SELECT</option>
</field>