Function Module_admin_cns_multi_moderations->get_form_fields
Definitions
adminzone/pages/modules/admin_cns_multi_moderations.php
- Get Tempcode for adding/editing form.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $name | SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | The name of the Multi Moderation |
| $post_text | LONG_TEXT | No | No | Blank (empty string) | N/A | N/A | The text to place as a post in the topic when the Multi Moderation is performed |
| $move_to | ?AUTO_LINK | No | No | Null | N/A | N/A | Move the topic to this forum (null: don't move) |
| $pin_state | ?BINARY | No | No | Null | N/A | N/A | What to change the pin state to (null: don't change) |
| $open_state | ?BINARY | No | No | Null | N/A | N/A | What to change the open state to (null: don't change) |
| $forum_multi_code | SHORT_TEXT | No | No | * | N/A | N/A | The forum multicode identifying where the multi-moderation is applicable |
| $title_suffix | SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | The title suffix |
Returns
- A pair: The input fields, Hidden fields
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get Tempcode for adding/editing form.
*
* @param SHORT_TEXT $name The name of the Multi Moderation
* @param LONG_TEXT $post_text The text to place as a post in the topic when the Multi Moderation is performed
* @param ?AUTO_LINK $move_to Move the topic to this forum (null: don't move)
* @param ?BINARY $pin_state What to change the pin state to (null: don't change)
* @param ?BINARY $open_state What to change the open state to (null: don't change)
* @param SHORT_TEXT $forum_multi_code The forum multicode identifying where the multi-moderation is applicable
* @param SHORT_TEXT $title_suffix The title suffix
* @return array A pair: The input fields, Hidden fields
*/
public function get_form_fields(string $name = '', string $post_text = '', ?int $move_to = null, ?int $pin_state = null, ?int $open_state = null, string $forum_multi_code = '*', string $title_suffix = '') : array
* Get Tempcode for adding/editing form.
*
* @param SHORT_TEXT $name The name of the Multi Moderation
* @param LONG_TEXT $post_text The text to place as a post in the topic when the Multi Moderation is performed
* @param ?AUTO_LINK $move_to Move the topic to this forum (null: don't move)
* @param ?BINARY $pin_state What to change the pin state to (null: don't change)
* @param ?BINARY $open_state What to change the open state to (null: don't change)
* @param SHORT_TEXT $forum_multi_code The forum multicode identifying where the multi-moderation is applicable
* @param SHORT_TEXT $title_suffix The title suffix
* @return array A pair: The input fields, Hidden fields
*/
public function get_form_fields(string $name = '', string $post_text = '', ?int $move_to = null, ?int $pin_state = null, ?int $open_state = null, string $forum_multi_code = '*', string $title_suffix = '') : array
