The hidden form field type provides a hidden field for saving a field whose value cannot be altered directly by a user in the Administrator. It can be altered in code or by editing the xml file.

If the parameter has a saved value this is entered in the text box. If not, the default value (if any) is entered. As the field is hidden, there is no visible field in the Administrator.

Example XML field definition:

<field name="mysecretvariable" type="hidden" default="" />

Parameters

Mandatory Parameters

  • type must be hidden.
  • name is the unique name of the field.
  • default is the data which needs to be collected.

Optional Parameters

  • class is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.