Add a hook accessible as a new public method in a class (or object)
This enables you to add a new accessible public method to an existing object, which will execute your hook implementation method when called upon.
Hook method can accept arguments and/or populate return values, just like any other regular method in the class. However, methods such as this do not have access to private or protected properties/methods in the class.
Methods added like this themselves become hookable as well.
Available since version 3.0.16. Added as an alias to addHook() for syntactic clarity, previous versions can use addHook() method with same arguments.
Example
// Adds a myHasParent($parent) method to all Page objects
$wire->addHookMethod('Page::myHasParent', function($event) {
$page = $event->object;
$parent = $event->arguments(0);
if(!$parent instanceof Page) {
throw new WireException("Page::myHasParent() requires a Page argument");
}
if($page->parents()->has($parent)) {
// this page has the given parent
$event->return = true;
} else {
// does not have the given parent
$event->return = false;
}
});
// Calling the new method (from any instance)
$parent = $pages->get('/products/');
if($page->myHasParent($parent)) {
// $page has the given $parent
} Usage
// basic usage
$string = $wire->addHookMethod(string $method, $toObject);
// usage with all arguments
$string = $wire->addHookMethod(string $method, $toObject, $toMethod = null, array $options = []);Arguments
| Name | Type(s) | Description |
|---|---|---|
method | string | Name of method you want to add, must not collide with existing property or method names:
|
toObject | object, null, callable | Specify one of the following:
|
toMethod (optional) | string, array | Method from $toObject, or function name to call on a hook event. This argument can be sustituted as the 2nd argument when the 2nd argument isn’t needed, or it can be the $options argument. |
options (optional) | array | Options typically aren't used in this context, but see Wire::addHookBefore() $options if you'd like. |
Return value
stringA special Hook ID (or CSV string of hook IDs) that should be retained if you need to remove the hook later.
API reference based on ProcessWire core version 3.0.236