Wire::addHookAfter() method

Add a hook to be executed after the hooked method

  • Use an "after" hook when you have code that should execute after a hookable method executes.
  • One benefit of using an "after" hook is that you can have it modify the return value.

Example

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

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

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

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

Usage

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

// usage with all arguments
$string = $wire->addHookAfter($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.163

Twitter updates

  • This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master (3.0.148) this version adds a ton of new & useful features and fixes more than 85 issues, with more than 225 commits over 7 months— More
    7 August 2020
  • ProcessWire 3.0.163 resolves more than a dozen issue reports and adds new hooks and configurable module install options, among numerous other updates. In addition, a major update to ProCache (v4.0) has been released— More
    24 July 2020
  • Weekly update for 17 July 2020 and a look at new features coming in next week's version of ProCache— More
    17 July 2020

Latest news

  • ProcessWire Weekly #326
    In the 326th issue of ProcessWire Weekly we're going to introduce the latest ProcessWire master version, take a quick look at a brand new third party module called Textformatter Video Markup, and more. Read on!
    Weekly.pw / 8 August 2020
  • ProcessWire 3.0.164 new master version
    This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master version (3.0.148) this version adds a ton of new and useful features and fixes more than 85 issues, with more than 225 commits over a period of 7 months.
    Blog / 7 August 2020
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer