Function __global->get_wiki_page_tree
Definitions
sources/wiki.php
- Get a list of maps containing all the subcategories, and path information, of the specified Wiki+ page - and those beneath it, recursively.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $wiki_seen | array | required parameter | N/A | N/A | A list of pages we've already seen (we don't repeat them in multiple list positions) |
| $page_id | ?AUTO_LINK | Null | N/A | N/A | The page being at the root of our recursion (null: true root page) |
| $breadcrumbs | ?string | Null | N/A | N/A | The breadcrumbs up to this point in the recursion (null: blank, as we are starting the recursion) |
| $page_details | ?array | Null | N/A | N/A | The details of the $page_id we are currently going through (null: look it up). This is here for efficiency reasons, as finding children IDs to recurse to also reveals the child's title |
| $do_stats | boolean | False | N/A | N/A | Whether to collect post counts with our breadcrumbs information |
| $use_compound_list | boolean | False | N/A | N/A | Whether to make a compound list (a pair of a comma-separated list of children, and the child array) |
| $levels | ?integer | Null | N/A | N/A | The number of recursive levels to search (null: all) |
Return
- A list of maps for all subcategories, contains more details if stats were requested
- Type: array
- Set: N/A
- Range: N/A