Function Hook_search_catalogue_entries->info

Definitions

sources/hooks/modules/search/catalogue_entries.php

  • Find details for this search hook.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$check_permissions boolean No No True N/A N/A Whether to check permissions
$member_id ?MEMBER No No Null N/A N/A The member ID to check with (null: current member)

Returns

  • Map of search hook details (null: hook is disabled) (false: access denied)
  • Type: ~?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find details for this search hook.
 *
 * @param  boolean $check_permissions Whether to check permissions
 * @param  ?MEMBER $member_id The member ID to check with (null: current member)
 * @return ~?array Map of search hook details (null: hook is disabled) (false: access denied)
 */
public function info(bool $check_permissions = true, ?int $member_id = null)