Function __global->cns_make_multi_moderation
Definitions
sources/cns_multi_moderations.php
- Add a Multi Moderation to the system.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: int
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $name | SHORT_TEXT | No | No | required parameter | N/A | N/A | The name of the Multi Moderation |
| $post_text | LONG_TEXT | No | No | required parameter | N/A | N/A | The post text to add when applying (blank: don't add a post) |
| $move_to | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The forum to move the topic when applying (null: do not move) |
| $pin_state | ?BINARY | No | No | required parameter | N/A | N/A | The pin state after applying (null: unchanged) |
| $open_state | ?BINARY | No | No | required parameter | N/A | N/A | The open state after applying (null: unchanged) |
| $forum_multi_code | SHORT_TEXT | No | No | * | N/A | N/A | The forum multi code for where this Multi Moderation may be applied |
| $title_suffix | SHORT_TEXT | No | No | Blank (empty string) | N/A | N/A | The title suffix |
Returns
- The ID of the Multi Moderation just added
- Type: AUTO_LINK
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Add a Multi Moderation to the system.
*
* @param SHORT_TEXT $name The name of the Multi Moderation
* @param LONG_TEXT $post_text The post text to add when applying (blank: don't add a post)
* @param ?AUTO_LINK $move_to The forum to move the topic when applying (null: do not move)
* @param ?BINARY $pin_state The pin state after applying (null: unchanged)
* @param ?BINARY $open_state The open state after applying (null: unchanged)
* @param SHORT_TEXT $forum_multi_code The forum multi code for where this Multi Moderation may be applied
* @param SHORT_TEXT $title_suffix The title suffix
* @return AUTO_LINK The ID of the Multi Moderation just added
*/
function cns_make_multi_moderation(string $name, string $post_text, ?int $move_to, ?int $pin_state, ?int $open_state, string $forum_multi_code = '*', string $title_suffix = '') : int
* Add a Multi Moderation to the system.
*
* @param SHORT_TEXT $name The name of the Multi Moderation
* @param LONG_TEXT $post_text The post text to add when applying (blank: don't add a post)
* @param ?AUTO_LINK $move_to The forum to move the topic when applying (null: do not move)
* @param ?BINARY $pin_state The pin state after applying (null: unchanged)
* @param ?BINARY $open_state The open state after applying (null: unchanged)
* @param SHORT_TEXT $forum_multi_code The forum multi code for where this Multi Moderation may be applied
* @param SHORT_TEXT $title_suffix The title suffix
* @return AUTO_LINK The ID of the Multi Moderation just added
*/
function cns_make_multi_moderation(string $name, string $post_text, ?int $move_to, ?int $pin_state, ?int $open_state, string $forum_multi_code = '*', string $title_suffix = '') : int
