What is @wordpress/hooks?
@wordpress/hooks is a library that provides a way to manage and trigger custom actions and filters in JavaScript. It is inspired by the WordPress PHP hooks system and allows developers to add, remove, and execute custom hooks in their JavaScript applications.
What are @wordpress/hooks's main functionalities?
Adding Actions
This feature allows you to add custom actions that can be triggered at specific points in your application. The code sample demonstrates how to add an action named 'myCustomAction' in the 'myNamespace' namespace.
const { addAction } = require('@wordpress/hooks');
addAction('myCustomAction', 'myNamespace', () => {
console.log('Action triggered!');
});
Doing Actions
This feature allows you to trigger actions that have been added. The code sample demonstrates how to trigger the 'myCustomAction' action, which will execute any functions hooked to it.
const { doAction } = require('@wordpress/hooks');
doAction('myCustomAction');
Adding Filters
This feature allows you to add custom filters that can modify data at specific points in your application. The code sample demonstrates how to add a filter named 'myCustomFilter' in the 'myNamespace' namespace, which appends ' filtered' to the input value.
const { addFilter } = require('@wordpress/hooks');
addFilter('myCustomFilter', 'myNamespace', (value) => {
return value + ' filtered';
});
Applying Filters
This feature allows you to apply filters to data, modifying it according to the functions hooked to the filter. The code sample demonstrates how to apply the 'myCustomFilter' filter to the string 'original value', resulting in 'original value filtered'.
const { applyFilters } = require('@wordpress/hooks');
const result = applyFilters('myCustomFilter', 'original value');
console.log(result); // Outputs: 'original value filtered'
Other packages similar to @wordpress/hooks
eventemitter3
EventEmitter3 is a high-performance event emitter for Node.js and the browser. It provides a similar mechanism for managing events but does not include the concept of filters. It is more focused on emitting and listening to events.
mitt
Mitt is a tiny functional event emitter. It provides a simple API for emitting and listening to events, similar to the action functionality in @wordpress/hooks, but does not include filtering capabilities.
hookable
Hookable is a lightweight library for creating hooks in JavaScript. It provides a similar API for adding and triggering hooks, including both actions and filters, making it a closer alternative to @wordpress/hooks.
@wordpress/hooks
A lightweight & efficient EventManager for JavaScript in WordPress.
Installation
Install the module
npm install @wordpress/hooks@next --save
Usage
API functions can be called via the global wp.hooks
like this wp.hooks.addAction()
, etc.
addAction( 'hook', 'vendor/plugin/function', callback, priority )
addFilter( 'hook', 'vendor/plugin/function', callback, priority )
removeAction( 'hook', 'vendor/plugin/function' )
removeFilter( 'hook', 'vendor/plugin/function' )
removeAllActions( 'hook' )
removeAllFilters( 'hook' )
doAction( 'hook', arg1, arg2, moreArgs, finalArg )
applyFilters( 'hook', content, arg1, arg2, moreArgs, finalArg )
doingAction( 'hook' )
doingFilter( 'hook' )
didAction( 'hook' )
didFilter( 'hook' )
hasAction( 'hook' )
hasFilter( 'hook' )
Background
See ticket #21170 for more information.
Features
- Fast and lightweight.
- Priorities system ensures hooks with lower integer priority are fired first.
- Uses native object hash lookup for finding hook callbacks.
- Utilizes insertion sort for keeping priorities correct. Best Case: O(n), worst case: O(n^2)