Function __global->get_hook_ob

Definitions

sources/zones.php

  • Get the specified hook implementation object and fail if it does not exist.
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: object

Parameters

Name Type Default Set Range Description
$type ID_TEXT required parameter N/A N/A The type of hook
$subtype ID_TEXT required parameter N/A N/A The hook sub-type to find hook implementations for (e.g. the name of a module)
$hook ID_TEXT required parameter N/A N/A The name of the hook
$classname_prefix string required parameter N/A N/A The hook class-name prefix, the classes are named {$classname_prefix}{$hook}
$fail_ok boolean False N/A N/A Whether to return null opposed to failing if the hook or its object does not exist

Return

  • The hook implementation object (null: hook was not found and $fail_ok was true)
  • Type: ?object
  • Set: N/A
  • Range: N/A