Wire::addHookProperty() method

Add a hook that will be accessible as a new object property.

This enables you to add a new accessible property to an existing object, which will execute your hook implementation method when called upon.

Note that adding a hook with this just makes it possible to call the hook as a property. Any hook property you add can also be called as a method, i.e. $obj->foo and $obj->foo() are the same.

Example

// Adding a hook property
$wire->addHookProperty('Page::lastModifiedStr', function($event) {
  $page = $event->object;
  $event->return = wireDate('relative', $page->modified);
});

// Accessing the property (from any instance)
echo $page->lastModifiedStr; // outputs: "10 days ago"

Usage

// basic usage
$string = $wire->addHookProperty($property, $toObject);

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

Arguments

NameType(s)Description
propertystring, array

Name of property you want to add, must not collide with existing property or method names:

  • Class::property to add the property to all instances of Class.
  • property if just adding to a single object instance.
  • Since 3.0.137 it may also be multiple properties 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

Options typically aren't used in this context, but see Wire::addHookBefore() $options if you'd like.

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

Twitter updates

  • New TinyMCE 6.2.0 Inputfield released for ProcessWire— More
    28 October 2022
  • This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it— More
    21 October 2022
  • This week we have ProcessWire 3.0.206 on the dev branch and a new version of the ProDevTools UserActivity module, which we'll take a closer look at in this post— More
    7 October 2022

Latest news

  • ProcessWire Weekly #447
    In the 447th issue of ProcessWire Weekly we'll share the latest core updates, introduce a new third party module called RockVideoThumbnailGrabber, and more. Read on!
    Weekly.pw / 3 December 2022
  • New rich text editor for ProcessWire
    This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it.
    Blog / 21 October 2022
  • 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