Function __global->get_root_comcode_pages

Definitions

sources/sitemap.php

  • Get Comcode pages from a zone, that sit in the root of that zone.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$zone ID_TEXT No No required parameter N/A N/A The zone to get for
$include_zone boolean No No False N/A N/A Use page-links in the mapping rather than just page names

Returns

  • Root Comcode pages, mapping page name to validation status
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get Comcode pages from a zone, that sit in the root of that zone.
 *
 * @param  ID_TEXT $zone The zone to get for
 * @param  boolean $include_zone Use page-links in the mapping rather than just page names
 * @return array Root Comcode pages, mapping page name to validation status
 */

function get_root_comcode_pages(string $zone, bool $include_zone = false) : array