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
- Returns: bool
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $zone | ID_TEXT | No | No | required parameter | N/A | N/A | The zone the page is being loaded in |
| $page | ID_TEXT | No | No | required parameter | N/A | N/A | The codename of the page to load |
| $options | integer | No | No | required parameter | N/A | N/A | A bitmask of SITEMAP_GEN_* options |
| $is_comcode_page | boolean | No | No | required parameter | N/A | N/A | Whether this is a Comcode page |
Returns
- Whether the page should be omitted
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find whether a page should be omitted from the sitemap.
*
* @param ID_TEXT $zone The zone the page is being loaded in
* @param ID_TEXT $page The codename of the page to load
* @param integer $options A bitmask of SITEMAP_GEN_* options
* @param boolean $is_comcode_page Whether this is a Comcode page
* @return boolean Whether the page should be omitted
*/
protected function _is_page_omitted_from_sitemap(string $zone, string $page, int $options, bool $is_comcode_page) : bool
* Find whether a page should be omitted from the sitemap.
*
* @param ID_TEXT $zone The zone the page is being loaded in
* @param ID_TEXT $page The codename of the page to load
* @param integer $options A bitmask of SITEMAP_GEN_* options
* @param boolean $is_comcode_page Whether this is a Comcode page
* @return boolean Whether the page should be omitted
*/
protected function _is_page_omitted_from_sitemap(string $zone, string $page, int $options, bool $is_comcode_page) : bool
