Function Hook_sitemap_base->_get_sitemap_object

Definitions

sources/sitemap.php

  • Get a particular Sitemap object. Used for easily tying in a different kind of child node.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$hook ID_TEXT No No required parameter N/A N/A The hook, i.e. the Sitemap object type. Usually the same as a content type.

Returns

  • The Sitemap object
  • Type: object
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a particular Sitemap object. Used for easily tying in a different kind of child node.
 *
 * @param  ID_TEXT $hook The hook, i.e. the Sitemap object type. Usually the same as a content type.
 * @return object The Sitemap object
 */

protected function _get_sitemap_object(string $hook) : object