Function __global->find_all_hook_obs
Definitions
sources/zones.php
- Get an array of all the hook implementation objects for a hook sub-type.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $type | ID_TEXT | No | No | required parameter | N/A | N/A | The type of hook |
| $subtype | ID_TEXT | No | No | required parameter | N/A | N/A | The hook sub-type to find hook implementations for (e.g. the name of a module) |
| $classname_prefix | string | No | No | required parameter | N/A | N/A | The hook class-name prefix, the classes are named {$classname_prefix}{$hook} |
Returns
- A map of hook implementation name to hook object
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get an array of all the hook implementation objects for a hook sub-type.
*
* @param ID_TEXT $type The type of hook
* @param ID_TEXT $subtype The hook sub-type to find hook implementations for (e.g. the name of a module)
* @param string $classname_prefix The hook class-name prefix, the classes are named {$classname_prefix}{$hook}
* @return array A map of hook implementation name to hook object
*/
function find_all_hook_obs(string $type, string $subtype, string $classname_prefix) : array
* Get an array of all the hook implementation objects for a hook sub-type.
*
* @param ID_TEXT $type The type of hook
* @param ID_TEXT $subtype The hook sub-type to find hook implementations for (e.g. the name of a module)
* @param string $classname_prefix The hook class-name prefix, the classes are named {$classname_prefix}{$hook}
* @return array A map of hook implementation name to hook object
*/
function find_all_hook_obs(string $type, string $subtype, string $classname_prefix) : array
