Function Hook_sitemap_base->_make_zone_concrete

Definitions

sources/sitemap.php

  • Remap '_SEARCH' zones if we can derive the zone from the page-link / or fix _SEARCH in the page-link if there's a known zone.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$zone ID_TEXT Yes No required parameter N/A N/A The zone in the recurse tree (replaced by reference)
&$page_link ID_TEXT Yes No required parameter N/A N/A The page-link (replaced by reference)

Returns

  • The page name (only returned because it could also be useful, saves some code)
  • Type: ID_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Remap '_SEARCH' zones if we can derive the zone from the page-link / or fix _SEARCH in the page-link if there's a known zone.
 *
 * @param  ID_TEXT $zone The zone in the recurse tree (replaced by reference)
 * @param  ID_TEXT $page_link The page-link (replaced by reference)
 * @return ID_TEXT The page name (only returned because it could also be useful, saves some code)
 */

protected function _make_zone_concrete(string &$zone, string &$page_link) : string