Wire::addHookBefore() method

Add a hook to be executed before the hooked method

  • Use a "before" hook when you have code that should execute before a hookable method executes.
  • One benefit of using a "before" hook is that you can have it modify the arguments that are sent to the hookable method.
  • This type of hook can also completely replace a hookable method if hook populates an $event->replace property. See the HookEvent class for details.

Example

// Attach hook to a method in current object
$this->addHookBefore('Page::path', $this, 'yourHookMethodName');

// Attach hook to an inline function
$this->addHookBefore('Page::path', function($event) { ... });

// Attach hook to a procedural function
$this->addHookBefore('Page::path', 'your_function_name');

// Attach hook from single object instance ($page) to inline function
$page->addHookBefore('path', function($event) { ... }); 

Usage

// basic usage
$string = $wire->addHookBefore($method, $toObject);

// usage with all arguments
$string = $wire->addHookBefore($method, $toObject, $toMethod = null, array $options = []);

Arguments

NameType(s)Description
methodstring, array

Method to hook in one of the following formats (please omit 3 leading underscores):

  • Class::method - If hooking to all object instances of the class.
  • method - If hooking to a single object instance.
  • Since 3.0.137 it may also be multiple methods to hook in CSV string or array.
toObjectobject, null, callable

Specify one of the following:

  • Object instance to call $toMethod from (like $this).
  • Inline function (closure) if providing implemention inline.
  • Procedural function name, if hook is implemented by a procedural function.
  • Null if you want to use the 3rd argument and don't need this argument.
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

Array of options that can modify behavior:

  • type (string): May be either 'method' or 'property'. If property, then it will respond to $obj->property rather than $obj->method(). The default type is 'method'.
  • priority (int): A number determining the priority of a hook, where lower numbers are executed before higher numbers. The default priority is 100.

Return value

string

A special Hook ID (or CSV string of hook IDs) that should be retained if you need to remove the hook later.


Wire methods and properties

API reference based on ProcessWire core version 3.0.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #456
    The 456th issue of ProcessWire Weekly covers latest core updates, introduces a new third party module called TextformatterRockDown, and more. Read on!
    Weekly.pw / 4 February 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK