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
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$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)

Returns

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

Preview

Code (PHP)

/**
 * Pre-fill part of the node structure, from what we know from the CMA hook.
 *
 * @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)
 * @return ?array A tuple: content ID, row, partial node structure (null: filtered)
 */
protected function _create_partial_node_structure(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) : ?array