Package Exports

@wordpress/hooks

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wordpress/hooks) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@wordpress/hooks

A lightweight & efficient EventManager for JavaScript in WordPress.

Installation

Install the module

npm install @wordpress/hooks --save

Usage

API functions can be called via the global wp.hooks like this wp.hooks.addAction(), etc.

A lightweight & efficient filter and action manager.

API Usage

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

Hooks can be added to an object via composition: import { createHooks } from '@wordpress/hooks';

myObject.hooks = createHooks();

API functions are then be called: myObject.hooks.addAction().

Events on action/filter add or remove

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.