Function Hook_sitemap_base->_is_page_omitted_from_sitemap

Definitions

sources/sitemap.php

  • Find whether a page should be omitted from the sitemap.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: bool

Parameters

Name Type Default Set Range Description
$zone ID_TEXT required parameter N/A N/A The zone the page is being loaded in
$page ID_TEXT required parameter N/A N/A The codename of the page to load
$options integer required parameter N/A N/A A bitmask of SITEMAP_GEN_* options
$is_comcode_page boolean required parameter N/A N/A Whether this is a Comcode page

Return

  • Whether the page should be omitted
  • Type: boolean
  • Set: N/A
  • Range: N/A