Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
@wordpress/hooks
Advanced tools
@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.
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'
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 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 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.
A lightweight & efficient EventManager for JavaScript.
Install the module
npm install @wordpress/hooks --save
In your JavaScript project, use hooks as follows:
import { createHooks } from '@wordpress/hooks';
myObject.hooks = createHooks();
myObject.hooks.addAction(); //etc...
In the WordPress context, API functions can be called via the global wp.hooks
like this wp.hooks.addAction()
, etc.
createHooks()
addAction( 'hookName', 'functionName', callback, priority )
addFilter( 'hookName', 'functionName', callback, priority )
removeAction( 'hookName', 'functionName' )
removeFilter( 'hookName', 'functionName' )
removeAllActions( 'hookName' )
removeAllFilters( 'hookName' )
doAction( 'hookName', arg1, arg2, moreArgs, finalArg )
applyFilters( 'hookName', content, arg1, arg2, moreArgs, finalArg )
doingAction( 'hookName' )
doingFilter( 'hookName' )
didAction( 'hookName' )
didFilter( 'hookName' )
hasAction( 'hookName' )
hasFilter( 'hookName' )
actions
filters
Whenever an action or filter is added or removed, a matching hookAdded
or hookRemoved
action is triggered.
hookAdded
action is triggered when addFilter()
or addAction()
method is called, passing values for hookName
, functionName
, callback
and priority
.hookRemoved
action is triggered when removeFilter()
or removeAction()
method is called, passing values for hookName
and functionName
.FAQs
WordPress hooks library.
The npm package @wordpress/hooks receives a total of 88,081 weekly downloads. As such, @wordpress/hooks popularity was classified as popular.
We found that @wordpress/hooks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 23 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.