Function __global->_render_menu_branch
Definitions
sources/menus.php
- Render a menu branch to Tempcode.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $branch | array | required parameter | N/A | N/A | The branch |
| $codename | SHORT_TEXT | required parameter | N/A | N/A | An identifier for the menu (will be used as a unique ID by menu JavaScript code) |
| $source_member | MEMBER | required parameter | N/A | N/A | The member the menu is being built as |
| $level | integer | required parameter | N/A | N/A | The depth into the menu that this branch resides at |
| $type | ID_TEXT | required parameter | N/A | N/A | The menu type (determines what templates get used) |
| $as_admin | boolean | required parameter | N/A | N/A | Whether to generate Comcode with admin privilege |
| $all_branches | array | required parameter | N/A | N/A | Array of all other branches |
| $apply_highlighting | boolean | required parameter | N/A | N/A | Whether to apply current-screen highlighting |
| $the_level | integer | 1 | N/A | N/A | The level |
Return
- A pair: array of parameters of the menu branch (or null if non-renderable, or Tempcode of something to attach), and whether it is expanded
- Type: array
- Set: N/A
- Range: N/A