Function __global->find_all_pages_wrap

Definitions

sources/zones.php

  • Get an array of all the pages everywhere in the zone, limited by the selection algorithm (for small sites everything will be returned, for larger ones it depends on the show method).
  • 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 name
$keep_ext_on boolean No No False N/A N/A Whether to leave file extensions on the page name
$consider_redirects boolean No No False N/A N/A Whether to take transparent redirects into account
$show_method integer No No 0 0 1 2 N/A Selection algorithm constant
$page_type ?ID_TEXT No No Null modules comcode html N/A Page type to show (null: all)

Returns

  • A map of page name to type (modules_custom, etc)
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get an array of all the pages everywhere in the zone, limited by the selection algorithm (for small sites everything will be returned, for larger ones it depends on the show method).
 *
 * @param  ID_TEXT $zone The zone name
 * @param  boolean $keep_ext_on Whether to leave file extensions on the page name
 * @param  boolean $consider_redirects Whether to take transparent redirects into account
 * @param  integer $show_method Selection algorithm constant
 * @set 0 1 2
 * @param  ?ID_TEXT $page_type Page type to show (null: all)
 * @set modules comcode html
 * @return array A map of page name to type (modules_custom, etc)
 */
function find_all_pages_wrap(string $zone, bool $keep_ext_on = false, bool $consider_redirects = false, int $show_method = 0, ?string $page_type = null) : array