Function Hook_sitemap_root->get_node

Definitions

sources/hooks/systems/sitemap/root.php

  • Find details of a position in the Sitemap.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$page_link ID_TEXT required parameter N/A N/A The page-link we are finding
$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)
$recurse_level integer 0 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 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
$row ?array Null N/A N/A Database row (null: lookup)
$return_anyway boolean False N/A N/A Whether to return the structure even if there was a callback. Do not pass this setting through via recursion due to memory concerns, it is used only to gather information to detect and prevent parent/child duplication of default entry points.

Return

  • Node structure (null: working via callback / error)
  • Type: ?array
  • Set: N/A
  • Range: N/A