Function Module_admin_menus->menu_branch

Definitions

adminzone/pages/modules/admin_menus.php

  • Show a branch-editor of the menu editor.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id ID_TEXT No No required parameter N/A N/A The menu we are displaying items for
$branch ?AUTO_LINK No No required parameter N/A N/A The parent branch holding the branch (null: root)
&$order integer Yes No required parameter N/A N/A The order this branch has in the editor (and due to linearly moving through, the number of branches shown assembled ready)
$clickable_sections boolean No No required parameter N/A N/A Whether childed branches themselves can have URLs (etc)
$menu_items array No No required parameter N/A N/A All rows on the menu

Returns

  • The part of the UI
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Show a branch-editor of the menu editor.
 *
 * @param  ID_TEXT $id The menu we are displaying items for
 * @param  ?AUTO_LINK $branch The parent branch holding the branch (null: root)
 * @param  integer $order The order this branch has in the editor (and due to linearly moving through, the number of branches shown assembled ready)
 * @param  boolean $clickable_sections Whether childed branches themselves can have URLs (etc)
 * @param  array $menu_items All rows on the menu
 * @return Tempcode The part of the UI
 */
public function menu_branch(string $id, ?int $branch, int &$order, bool $clickable_sections, array $menu_items) : object