Function Hook_sitemap_page->handles_page_link

Definitions

sources/hooks/systems/sitemap/page.php

  • Find if a page-link will be covered by this node.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

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
$options integer No No required parameter N/A N/A A bitmask of SITEMAP_GEN_* options

Returns

  • A SITEMAP_NODE_* constant
  • Type: integer
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find if a page-link will be covered by this node.
 *
 * @param  ID_TEXT $page_link The page-link
 * @param  integer $options A bitmask of SITEMAP_GEN_* options
 * @return integer A SITEMAP_NODE_* constant
 */

public function handles_page_link(string $page_link, int $options) : int