Function __global->retrieve_sitemap_node
Definitions
sources/sitemap.php
- Find details of a position in the Sitemap (shortcut into the object structure).
- 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 | Blank (empty string) | N/A | N/A | The page-link we are finding (blank: root) |
| $callback | ?mixed | No | No | Null | N/A | N/A | Callback function to send discovered page-links to (null: return) |
| $valid_node_types | ?array | No | No | Null | N/A | N/A | List of node types we will return/recurse-through (null: no limit) |
| $child_cutoff | ?integer | No | No | Null | N/A | N/A | Maximum number of children before we cut off all children (null: no limit) |
| $max_recurse_depth | ?integer | No | No | Null | N/A | N/A | How deep to go from the Sitemap root (null: no limit) |
| $options | integer | No | No | 0 | N/A | N/A | A bitmask of SITEMAP_GEN_* options |
| $zone | ID_TEXT | No | No | _SEARCH | N/A | N/A | The zone we will consider ourselves to be operating in (needed due to transparent redirects feature) |
| $meta_gather | integer | No | No | 0 | N/A | N/A | A bitmask of SITEMAP_GATHER_* constants, of extra data to include |
Returns
- Node structure (null: working via callback / error)
- Type: ?array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find details of a position in the Sitemap (shortcut into the object structure).
*
* @param ID_TEXT $page_link The page-link we are finding (blank: root)
* @param ?mixed $callback Callback function to send discovered page-links to (null: return)
* @param ?array $valid_node_types List of node types we will return/recurse-through (null: no limit)
* @param ?integer $child_cutoff Maximum number of children before we cut off all children (null: no limit)
* @param ?integer $max_recurse_depth How deep to go from the Sitemap root (null: no limit)
* @param integer $options A bitmask of SITEMAP_GEN_* options
* @param ID_TEXT $zone The zone we will consider ourselves to be operating in (needed due to transparent redirects feature)
* @param integer $meta_gather A bitmask of SITEMAP_GATHER_* constants, of extra data to include
* @return ?array Node structure (null: working via callback / error)
*/
function retrieve_sitemap_node(string $page_link = '', $callback = null, ?array $valid_node_types = null, ?int $child_cutoff = null, ?int $max_recurse_depth = null, int $options = 0, string $zone = '_SEARCH', int $meta_gather = 0) : ?array
* Find details of a position in the Sitemap (shortcut into the object structure).
*
* @param ID_TEXT $page_link The page-link we are finding (blank: root)
* @param ?mixed $callback Callback function to send discovered page-links to (null: return)
* @param ?array $valid_node_types List of node types we will return/recurse-through (null: no limit)
* @param ?integer $child_cutoff Maximum number of children before we cut off all children (null: no limit)
* @param ?integer $max_recurse_depth How deep to go from the Sitemap root (null: no limit)
* @param integer $options A bitmask of SITEMAP_GEN_* options
* @param ID_TEXT $zone The zone we will consider ourselves to be operating in (needed due to transparent redirects feature)
* @param integer $meta_gather A bitmask of SITEMAP_GATHER_* constants, of extra data to include
* @return ?array Node structure (null: working via callback / error)
*/
function retrieve_sitemap_node(string $page_link = '', $callback = null, ?array $valid_node_types = null, ?int $child_cutoff = null, ?int $max_recurse_depth = null, int $options = 0, string $zone = '_SEARCH', int $meta_gather = 0) : ?array