Function __global->find_sitemap_object
Definitions
sources/sitemap.php
- Find the Sitemap object that serves a particular page-link.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $page_link | ID_TEXT | No | No | required parameter | N/A | N/A | The page-link we are finding a Sitemap object for (blank: root) |
| $options | integer | No | No | 0 | N/A | N/A | A bitmask of SITEMAP_GEN_* options |
Returns
- A pair: the Sitemap object, and whether you need to make a virtual call (null: cannot find one)
- Type: ?array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find the Sitemap object that serves a particular page-link.
*
* @param ID_TEXT $page_link The page-link we are finding a Sitemap object for (blank: root)
* @param integer $options A bitmask of SITEMAP_GEN_* options
* @return ?array A pair: the Sitemap object, and whether you need to make a virtual call (null: cannot find one)
*/
function find_sitemap_object(string $page_link, int $options = 0) : ?array
* Find the Sitemap object that serves a particular page-link.
*
* @param ID_TEXT $page_link The page-link we are finding a Sitemap object for (blank: root)
* @param integer $options A bitmask of SITEMAP_GEN_* options
* @return ?array A pair: the Sitemap object, and whether you need to make a virtual call (null: cannot find one)
*/
function find_sitemap_object(string $page_link, int $options = 0) : ?array
