Function Hook_sitemap_content->_create_partial_node_structure

Definitions

sources/sitemap.php

  • Pre-fill part of the node structure, from what we know from the CMA hook.
  • Visibility: protected
  • 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 required parameter N/A N/A Callback function to send discovered page-links to (null: return)
$valid_node_types ?array required parameter N/A N/A List of node types we will return/recurse-through (null: no limit)
$child_cutoff ?integer required parameter N/A N/A Maximum number of children before we cut off all children (null: no limit)
$max_recurse_depth ?integer required parameter N/A N/A How deep to go from the Sitemap root (null: no limit)
$recurse_level integer 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 required parameter N/A N/A A bitmask of SITEMAP_GEN_* options
$zone ID_TEXT 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 required parameter N/A N/A A bitmask of SITEMAP_GATHER_* constants, of extra data to include
$row ?array required parameter N/A N/A Database row (null: lookup)

Return

  • A tuple: content ID, row, partial node structure (null: filtered)
  • Type: ?array
  • Set: N/A
  • Range: N/A