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.


// 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) { ... }); 


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

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


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


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.200

Twitter updates

  • Weekly update for July 22– Looking back at what web development was like in the year 2000. Plus some more discussion on the path from CKEditor 4 to CkEditor 5 in ProcessWire: More
    22 July 2022
  • ProcessWire 3.0.203 core updates: new support for custom fields on comments and more— More
    15 July 2022
  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022

Latest news

  • ProcessWire Weekly #428
    In the 428th issue of ProcessWire Weekly we'll take a quick dive into the weekly update from Ryan, introduce a couple of brand new third party modules, and more. Read on!
    Weekly.pw / 23 July 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits