Function __global->alternate_fields_set__end
Definitions
sources/form_templates.php
- Show a field set that has just been finished off.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $set_name | ID_TEXT | No | No | required parameter | N/A | N/A | The codename for this field set (blank: just collect raw fields, no actual field set) |
| $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) |
| $fields | Tempcode | No | No | required parameter | N/A | N/A | The field set Tempcode |
| $required | boolean | No | No | required parameter | N/A | N/A | Whether it is required that this field set be filled in |
| $existing_image_preview_url | ?URLPATH | No | No | Null | N/A | N/A | Image URL to show, of the existing selection for this field (null: N/A) (blank: N/A) |
| $raw | boolean | No | No | False | N/A | N/A | Whether we just want the raw set contents, without any wrapper field row |
| $default_set | string | No | No | Blank (empty string) | N/A | N/A | The default set to pre-select |
Returns
- The field set
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Show a field set that has just been finished off.
*
* @param ID_TEXT $set_name The codename for this field set (blank: just collect raw fields, no actual field set)
* @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 Tempcode $fields The field set Tempcode
* @param boolean $required Whether it is required that this field set be filled in
* @param ?URLPATH $existing_image_preview_url Image URL to show, of the existing selection for this field (null: N/A) (blank: N/A)
* @param boolean $raw Whether we just want the raw set contents, without any wrapper field row
* @param string $default_set The default set to pre-select
* @return Tempcode The field set
*/
function alternate_fields_set__end(string $set_name, $pretty_name, $description, object $fields, bool $required, ?string $existing_image_preview_url = null, bool $raw = false, string $default_set = '') : object
* Show a field set that has just been finished off.
*
* @param ID_TEXT $set_name The codename for this field set (blank: just collect raw fields, no actual field set)
* @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 Tempcode $fields The field set Tempcode
* @param boolean $required Whether it is required that this field set be filled in
* @param ?URLPATH $existing_image_preview_url Image URL to show, of the existing selection for this field (null: N/A) (blank: N/A)
* @param boolean $raw Whether we just want the raw set contents, without any wrapper field row
* @param string $default_set The default set to pre-select
* @return Tempcode The field set
*/
function alternate_fields_set__end(string $set_name, $pretty_name, $description, object $fields, bool $required, ?string $existing_image_preview_url = null, bool $raw = false, string $default_set = '') : object