Download the PHP package amphibee/hookable without Composer
On this page you can find all versions of the php package amphibee/hookable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download amphibee/hookable
More information about amphibee/hookable
Files in amphibee/hookable
Package hookable
Short Description An object-oriented package for the WordPress Plugin API.
License MIT
Homepage https://github.com/amphibee/hookable
Informations about the package hookable
An object-oriented package for WordPress hooks.
This package provides an object-oriented API for use with the WordPress Plugin API. The package also includes automatic "number of arguments" calculation and chainable callbacks.
Installation
You can install the package via composer:
Usage
There is a dedicated class for each type of "hook".
Actions
To interact with actions, you need to use the \AmphiBee\Hooks\Action
class.
Registering actions:
To register an action, call the Action::add()
method. This method takes 3 arguments:
You do not need to provide the number of parameters that the callback takes. This is automatically resolved using the Reflection API.
Chained callbacks:
It is possible to provide extra callbacks that run after your initial callback. For example, you may wish to call one of your application helpers to do something extra.
The chained callbacks will receive the return value and all arguments that the initial callback received.
Running actions:
You can fire / run an action using the Action::do()
method, as well as pass in arguments just like you would with do_action
.
Removing actions:
To remove an action, use the Action::remove()
method:
Filters
To interact with filters, you need to use the \AmphiBee\Hooks\Filter
class.
Registering filters:
To register a filter, use the Filter::add()
method:
Chained callbacks:
It is possible to provide extra callbacks that run after your initial callback. For example, you may wish to call one of your application helpers to do something extra.
The chained callbacks will behave the same way as actions and will receive the return value of the initial callback and then any arguments that were passed to the initial callback.
The example above will pass the return value of $title . ' is the title'
to the strtoupper
method.
Applying filters:
You can apply filters using the Filter::do()
or Filter::apply()
methods (Filter::apply()
is an alias of Filter::do()
). These behave in the same way as the Action::do()
method and take the same arguments.
Removing filters:
You can remove filters using the Filter::remove()
method. This behaves the same as the Action::remove()
method and both use the same underlying logic.
Hookable classes
This package provides a convenient Hookable
interface that can be used to register single-use class callbacks.
Receiving hook arguments:
To receive the arguments passed from the caller, define a constructor on your class and assign them to properties:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Ryan Chandler
- All Contributors
License
The MIT License (MIT). Please see License File for more information.