Function __global->cns_make_forum_grouping
Definitions
sources/cns_forums_action.php
- Add a forum grouping.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: int
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $title | SHORT_TEXT | No | No | required parameter | N/A | N/A | The title of the forum grouping |
| $description | SHORT_TEXT | No | No | required parameter | N/A | N/A | The description of the forum grouping |
| $expanded_by_default | BINARY | No | No | 1 | N/A | N/A | Whether the forum grouping will be shown expanded by default (as opposed to contracted, where contained forums will not be shown until expansion) |
Returns
- The ID of the forum grouping just added
- Type: AUTO_LINK
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Add a forum grouping.
*
* @param SHORT_TEXT $title The title of the forum grouping
* @param SHORT_TEXT $description The description of the forum grouping
* @param BINARY $expanded_by_default Whether the forum grouping will be shown expanded by default (as opposed to contracted, where contained forums will not be shown until expansion)
* @return AUTO_LINK The ID of the forum grouping just added
*/
function cns_make_forum_grouping(string $title, string $description, int $expanded_by_default = 1) : int
* Add a forum grouping.
*
* @param SHORT_TEXT $title The title of the forum grouping
* @param SHORT_TEXT $description The description of the forum grouping
* @param BINARY $expanded_by_default Whether the forum grouping will be shown expanded by default (as opposed to contracted, where contained forums will not be shown until expansion)
* @return AUTO_LINK The ID of the forum grouping just added
*/
function cns_make_forum_grouping(string $title, string $description, int $expanded_by_default = 1) : int
