Function Module_admin_site_messaging->get_form_fields
Definitions
adminzone/pages/modules/admin_site_messaging.php
- Get Tempcode for a site message form.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $id | ?AUTO_LINK | Null | N/A | N/A | The message ID (null: new) |
| $title | SHORT_TEXT | Blank (empty string) | N/A | N/A | The title (blank: new) |
| $message | LONG_TEXT | Blank (empty string) | N/A | N/A | The message (blank: new) |
| $type | ID_TEXT | inform | N/A | N/A | The message type |
| $start_date_time | ?TIME | Null | N/A | N/A | The start time (null: not set or new) |
| $end_date_time | ?TIME | Null | N/A | N/A | The end time (null: not set or new) |
| $validated | BINARY | 1 | N/A | N/A | Whether this entry is validated |
| $groups | array | [] | N/A | N/A | List of groups of which to limit the message (empty: no limit or new) |
| $page_links | array | [] | N/A | N/A | List of page links of which to limit the message (empty: no limit or new) |
Return
- A duple: The input fields, hidden fields
- Type: array
- Set: N/A
- Range: N/A