Function __global->form_input_multi_list
Definitions
sources/form_templates.php
- Get the Tempcode for a listbox with multiple selections.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $pretty_name | mixed | No | No | required parameter | N/A | N/A | A human intelligible name for this input field, provided in plain-text format (string or Tempcode) |
| $description | mixed | No | No | required parameter | N/A | N/A | A description for this input field, provided in HTML format (string or Tempcode) |
| $name | ID_TEXT | No | No | required parameter | N/A | N/A | The name which this input field is for |
| $content | Tempcode | No | No | required parameter | N/A | N/A | The list entries for our list; you compose these via attaching together form_input_list_entry calls |
| $tabindex | ?integer | No | No | Null | N/A | N/A | The tab index of the field (null: not specified) |
| $size | integer | No | No | 5 | N/A | N/A | How much space the list takes up |
| $required | boolean | No | No | False | N/A | N/A | Whether at least one must be selected |
| $custom_name | ?ID_TEXT | No | No | Null | N/A | N/A | Name for custom value to be entered to (null: no custom value allowed) |
| $custom_value | ?mixed | No | No | Null | N/A | N/A | Value for custom value, string (accept single value) or array (accept multiple values) (null: no custom value known) |
Returns
- The input field
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the Tempcode for a listbox with multiple selections.
*
* @param mixed $pretty_name A human intelligible name for this input field, provided in plain-text format (string or Tempcode)
* @param mixed $description A description for this input field, provided in HTML format (string or Tempcode)
* @param ID_TEXT $name The name which this input field is for
* @param Tempcode $content The list entries for our list; you compose these via attaching together form_input_list_entry calls
* @param ?integer $tabindex The tab index of the field (null: not specified)
* @param integer $size How much space the list takes up
* @param boolean $required Whether at least one must be selected
* @param ?ID_TEXT $custom_name Name for custom value to be entered to (null: no custom value allowed)
* @param ?mixed $custom_value Value for custom value, string (accept single value) or array (accept multiple values) (null: no custom value known)
* @return Tempcode The input field
*/
function form_input_multi_list($pretty_name, $description, string $name, object $content, ?int $tabindex = null, int $size = 5, bool $required = false, ?string $custom_name = null, $custom_value = null) : object
* Get the Tempcode for a listbox with multiple selections.
*
* @param mixed $pretty_name A human intelligible name for this input field, provided in plain-text format (string or Tempcode)
* @param mixed $description A description for this input field, provided in HTML format (string or Tempcode)
* @param ID_TEXT $name The name which this input field is for
* @param Tempcode $content The list entries for our list; you compose these via attaching together form_input_list_entry calls
* @param ?integer $tabindex The tab index of the field (null: not specified)
* @param integer $size How much space the list takes up
* @param boolean $required Whether at least one must be selected
* @param ?ID_TEXT $custom_name Name for custom value to be entered to (null: no custom value allowed)
* @param ?mixed $custom_value Value for custom value, string (accept single value) or array (accept multiple values) (null: no custom value known)
* @return Tempcode The input field
*/
function form_input_multi_list($pretty_name, $description, string $name, object $content, ?int $tabindex = null, int $size = 5, bool $required = false, ?string $custom_name = null, $custom_value = null) : object
