Skip to main content
Version: 5.2 (Current)

Status Form Field

The status form field type provides a list box of statuses. This field extends PredefinedlistField.

  • type (mandatory) must be status.
  • name (mandatory) is the unique name of the field.
  • label (mandatory) (translatable) is the field html label.
  • description (optional) (translatable) is the field description.
  • multiple (optional) if set to true allows multiple items to be selected at the same time. Set to false to allow single selection.
  • required (optional) if set to true, the first field option should be empty, see last example.

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

Example XML parameter definition​

<field
        name="mystatus" 
        type="status"
        label="Choose" 
        description=""
/>

Based on the source code this returns the following entries in a list:
Trashed - JTRASHED
Disabled - JDISABLED
Enabled - JENABLED
Archived - JARCHIVED
All - JALL