Function __global->_create_selection_list_wiki_page_tree
Definitions
sources/wiki.php
- Helper function. Get a nice formatted HTML list of all the children beneath the specified Wiki+ page. This function is recursive.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| &$wiki_seen | array | Yes | No | required parameter | N/A | N/A | A list of pages we've already seen (we don't repeat them in multiple list positions) |
| $select | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The Wiki+ page to select by default (null: none) |
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The Wiki+ page to look beneath |
| $breadcrumbs | string | No | No | required parameter | N/A | N/A | Breadcrumbs built up so far, in recursion (blank: starting recursion) |
| $title | SHORT_TEXT | No | No | required parameter | N/A | N/A | The title of the Wiki+ page to look beneath |
| $use_compound_list | boolean | No | No | False | N/A | N/A | Whether to create a compound list (gets pairs: Tempcode, and comma-separated list of children) |
| $ins_format | boolean | No | No | False | N/A | N/A | Whether to use titles in IDs after a ! (used on tree edit page) |
Returns
- Tempcode for the list / pair of Tempcode and compound
- Type: mixed
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Helper function. Get a nice formatted HTML list of all the children beneath the specified Wiki+ page. This function is recursive.
*
* @param array $wiki_seen A list of pages we've already seen (we don't repeat them in multiple list positions)
* @param ?AUTO_LINK $select The Wiki+ page to select by default (null: none)
* @param AUTO_LINK $id The Wiki+ page to look beneath
* @param string $breadcrumbs Breadcrumbs built up so far, in recursion (blank: starting recursion)
* @param SHORT_TEXT $title The title of the Wiki+ page to look beneath
* @param boolean $use_compound_list Whether to create a compound list (gets pairs: Tempcode, and comma-separated list of children)
* @param boolean $ins_format Whether to use titles in IDs after a ! (used on tree edit page)
* @return mixed Tempcode for the list / pair of Tempcode and compound
*/
function _create_selection_list_wiki_page_tree(array &$wiki_seen, ?int $select, int $id, string $breadcrumbs, string $title, bool $use_compound_list = false, bool $ins_format = false)
* Helper function. Get a nice formatted HTML list of all the children beneath the specified Wiki+ page. This function is recursive.
*
* @param array $wiki_seen A list of pages we've already seen (we don't repeat them in multiple list positions)
* @param ?AUTO_LINK $select The Wiki+ page to select by default (null: none)
* @param AUTO_LINK $id The Wiki+ page to look beneath
* @param string $breadcrumbs Breadcrumbs built up so far, in recursion (blank: starting recursion)
* @param SHORT_TEXT $title The title of the Wiki+ page to look beneath
* @param boolean $use_compound_list Whether to create a compound list (gets pairs: Tempcode, and comma-separated list of children)
* @param boolean $ins_format Whether to use titles in IDs after a ! (used on tree edit page)
* @return mixed Tempcode for the list / pair of Tempcode and compound
*/
function _create_selection_list_wiki_page_tree(array &$wiki_seen, ?int $select, int $id, string $breadcrumbs, string $title, bool $use_compound_list = false, bool $ins_format = false)