Function Hook_sitemap_base->_request_page_details

Definitions

sources/sitemap.php

  • Take the specified parameters, and try to find the corresponding page.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$page ID_TEXT No No required parameter N/A N/A The codename of the page to load
$zone ID_TEXT No No required parameter N/A N/A The zone the page is being loaded in
$page_type ?ID_TEXT No No Null N/A N/A The type of page - for if you know it (null: don't know it)

Returns

  • A list of details (false: page not found)
  • Type: ~array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Take the specified parameters, and try to find the corresponding page.
 *
 * @param  ID_TEXT $page The codename of the page to load
 * @param  ID_TEXT $zone The zone the page is being loaded in
 * @param  ?ID_TEXT $page_type The type of page - for if you know it (null: don't know it)
 * @return ~array A list of details (false: page not found)
 */

protected function _request_page_details(string $page, string $zone, ?string $page_type = null)