Function Hook_sitemap_banner->get_privilege_page

Definitions

sources/hooks/systems/sitemap/banner.php

  • Get the permission page that nodes matching $page_link in this hook are tied to.The permission page is where privileges may be overridden against.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$page_link string No No required parameter N/A N/A The page-link

Returns

  • The permission page (null: none)
  • Type: ?ID_TEXT
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the permission page that nodes matching $page_link in this hook are tied to.The permission page is where privileges may be overridden against.
 *
 * @param  string $page_link The page-link
 * @return ?ID_TEXT The permission page (null: none)
 */
public function get_privilege_page(string $page_link) : ?string