Actions

Difference between revisions of "User form field type"

From Joomla! Documentation

(Change from XML to user form field)
(changed example, added implemented by, removed stub)
 
Line 1: Line 1:
{{stub}}
 
 
The '''user''' form field type provides a modal select box of users.
 
The '''user''' form field type provides a modal select box of users.
  
Line 9: Line 8:
 
* '''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.
 
* '''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:
 
Example user form field definition:
    <field name="title" type="user" label="Select a user" />
+
<source type="php">
 
+
<field name="modified_user_id" type="user"
 +
label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
 +
class="readonly"
 +
readonly="true"
 +
filter="unset" />
 +
</source>
 
<noinclude>
 
<noinclude>
 
=== See also ===
 
=== See also ===
 
* [[Standard form field types|List of standard form field types]]
 
* [[Standard form field types|List of standard form field types]]
 
[[Category:Standard form field types]]</noinclude>
 
[[Category:Standard form field types]]</noinclude>

Latest revision as of 02:33, 19 September 2013

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" />

See also