Function Hook_sitemap_content->_get_children_nodes
Definitions
sources/sitemap.php
- Get a list of child nodes, from what we know from the CMA hook.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $content_id | ID_TEXT | No | No | required parameter | N/A | N/A | The content ID |
| $page_link | ID_TEXT | No | No | required parameter | N/A | N/A | The page-link we are finding |
| $callback | ?mixed | No | No | required parameter | N/A | N/A | Callback function to send discovered page-links to (null: return) |
| $valid_node_types | ?array | No | No | required parameter | N/A | N/A | List of node types we will return/recurse-through (null: no limit) |
| $child_cutoff | ?integer | No | No | required parameter | N/A | N/A | Maximum number of children before we cut off all children (null: no limit) |
| $max_recurse_depth | ?integer | No | No | required parameter | N/A | N/A | How deep to go from the Sitemap root (null: no limit) |
| $recurse_level | integer | No | No | required parameter | N/A | N/A | Our recursion depth (used to limit recursion, or to calculate importance of page-link, used for instance by XML Sitemap [deeper is typically less important]) |
| $options | integer | No | No | required parameter | N/A | N/A | A bitmask of SITEMAP_GEN_* options |
| $zone | ID_TEXT | No | No | required parameter | 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 | required parameter | N/A | N/A | A bitmask of SITEMAP_GATHER_* constants, of extra data to include |
| $row | ?array | No | No | required parameter | N/A | N/A | Database row (null: lookup) |
| $extra_where_entries | string | No | No | Blank (empty string) | N/A | N/A | Extra SQL piece for considering which entries to load |
| $explicit_order_by_entries | ?string | No | No | Null | N/A | N/A | Order by for entries (null: alphabetical title) |
| $explicit_order_by_subcategories | ?string | No | No | Null | N/A | N/A | Order by for categories (null: alphabetical title) |
Returns
- Child nodes (null: not retrieved yet)
- Type: ?array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a list of child nodes, from what we know from the CMA hook.
*
* @param ID_TEXT $content_id The content ID
* @param ID_TEXT $page_link The page-link we are finding
* @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 $recurse_level Our recursion depth (used to limit recursion, or to calculate importance of page-link, used for instance by XML Sitemap [deeper is typically less important])
* @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
* @param ?array $row Database row (null: lookup)
* @param string $extra_where_entries Extra SQL piece for considering which entries to load
* @param ?string $explicit_order_by_entries Order by for entries (null: alphabetical title)
* @param ?string $explicit_order_by_subcategories Order by for categories (null: alphabetical title)
* @return ?array Child nodes (null: not retrieved yet)
*/
protected function _get_children_nodes(string $content_id, string $page_link, $callback, ?array $valid_node_types, ?int $child_cutoff, ?int $max_recurse_depth, int $recurse_level, int $options, string $zone, int $meta_gather, ?array $row, string $extra_where_entries = '', ?string $explicit_order_by_entries = null, ?string $explicit_order_by_subcategories = null) : ?array
* Get a list of child nodes, from what we know from the CMA hook.
*
* @param ID_TEXT $content_id The content ID
* @param ID_TEXT $page_link The page-link we are finding
* @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 $recurse_level Our recursion depth (used to limit recursion, or to calculate importance of page-link, used for instance by XML Sitemap [deeper is typically less important])
* @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
* @param ?array $row Database row (null: lookup)
* @param string $extra_where_entries Extra SQL piece for considering which entries to load
* @param ?string $explicit_order_by_entries Order by for entries (null: alphabetical title)
* @param ?string $explicit_order_by_subcategories Order by for categories (null: alphabetical title)
* @return ?array Child nodes (null: not retrieved yet)
*/
protected function _get_children_nodes(string $content_id, string $page_link, $callback, ?array $valid_node_types, ?int $child_cutoff, ?int $max_recurse_depth, int $recurse_level, int $options, string $zone, int $meta_gather, ?array $row, string $extra_where_entries = '', ?string $explicit_order_by_entries = null, ?string $explicit_order_by_subcategories = null) : ?array
