Function Module_admin_cns_forums->get_forum_tree
Definitions
adminzone/pages/modules/admin_cns_forums.php
- Get a UI to choose a forum to edit.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $id | AUTO_LINK | required parameter | N/A | N/A | The ID of the forum we are generating the tree below (start recursion with db_get_first_id()) |
| $forum | SHORT_TEXT | required parameter | N/A | N/A | The name of the forum $id |
| $all_forums | array | required parameter | N/A | N/A | A list of rows of all forums, or [] if the function is to get the list itself |
| $position | integer | 0 | N/A | N/A | The relative position of this forum wrt the others on the same level/branch in the UI |
| $sub_num_in_parent_forum_grouping | integer | 1 | N/A | N/A | The number of forums in the parent forum grouping |
| $order_sub_alpha | ?BINARY | Null | N/A | N/A | Whether to order own subcategories alphabetically (null: ask the DB) |
| $parent_order_sub_alpha | ?BINARY | Null | N/A | N/A | Whether to order subcategories alphabetically (null: ask the DB) |
| $huge | boolean | False | N/A | N/A | Whether we are dealing with a huge forum structure |
Return
- The UI
- Type: Tempcode
- Set: N/A
- Range: N/A