Function __global->_form_input
Definitions
sources/form_templates.php
- Helper function to show an input field.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $name | ID_TEXT | required parameter | N/A | N/A | The codename for this field (blank: N/A) |
| $pretty_name | mixed | required parameter | N/A | N/A | A human intelligible name for this input field, provided in plain-text format (string or Tempcode) |
| $description | mixed | required parameter | N/A | N/A | A description for this input field, provided in HTML format (string or Tempcode) |
| $input | Tempcode | required parameter | N/A | N/A | The actual raw input field |
| $required | boolean | required parameter | N/A | N/A | Whether it is required that this field be filled in |
| $comcode | boolean | False | N/A | N/A | Whether this field may contain Comcode |
| $tabindex | ?integer | Null | N/A | N/A | The tab index (null: none specified) |
| $w | boolean | False | N/A | N/A | Whether it is a textarea field |
| $skip_label | boolean | False | N/A | N/A | Whether to skip displaying a label for the field |
| $description_side | mixed | Blank (empty string) | N/A | N/A | A secondary side description for this input field, provided in HTML format (string or Tempcode) |
| $pattern_error | ?string | Null | N/A | N/A | Custom regex pattern validation error (null: none) |
Return
- The field
- Type: Tempcode
- Set: N/A
- Range: N/A