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