User form field type

From Joomla! Documentation

Revision as of 09:16, 28 May 2019 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎español • ‎français

The user form field type provides a modal select box of users.

  • type (mandatory) must be user.
  • name (mandatory) is the unique name of the field. This must match the name of the query results column that contains the values that will be shown to the user in the drop-down list, unless a different name is specified in the value_field attribute.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
  • class (optional) is a CSS class name for the HTML form field.
  • size (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.

Implemented by: libraries/cms/form/field/user.php

Example user form field definition:

<field name="modified_user_id" type="user"
	label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
	class="readonly"
	readonly="true"
	filter="unset" />

Note!

The user field only works on administration forms and should not be added to front-end forms.

See also