Function Module_cms_comcode_pages->menu_branch_selection_under

Definitions

cms/pages/modules/cms_comcode_pages.php

  • Find menu branches for selection, in a tree structure.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$parent_id ?AUTO_LINK No No required parameter N/A N/A Parent ID (null: root)
$menu_branches array No No required parameter N/A N/A List of menu branches
$existing_menu_branch ?AUTO_LINK No No required parameter N/A N/A The menu branch currently selected (null: none)
$page_link string No No required parameter N/A N/A Page-link of page being edited
$prefix string No No Blank (empty string) N/A N/A Prefix before labels

Returns

  • The menu branch list entries
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find menu branches for selection, in a tree structure.
 *
 * @param  ?AUTO_LINK $parent_id Parent ID (null: root)
 * @param  array $menu_branches List of menu branches
 * @param  ?AUTO_LINK $existing_menu_branch The menu branch currently selected (null: none)
 * @param  string $page_link Page-link of page being edited
 * @param  string $prefix Prefix before labels
 * @return Tempcode The menu branch list entries
 */
protected function menu_branch_selection_under(?int $parent_id, array $menu_branches, ?int $existing_menu_branch, string $page_link, string $prefix = '') : object