Function Module_cms_comcode_pages->organise_page_tree

Definitions

cms/pages/modules/cms_comcode_pages.php

  • Get the page sitemap tree structure.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$pages array Yes No required parameter N/A N/A An array of pages
$under ID_TEXT No No Blank (empty string) N/A N/A The page we are looking under

Returns

  • The structure
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the page sitemap tree structure.
 *
 * @param  array $pages An array of pages
 * @param  ID_TEXT $under The page we are looking under
 * @return Tempcode The structure
 */
public function organise_page_tree(array &$pages, string $under = '') : object