This library uses PHP Attributes (introduced in PHP version 8.0) to automagically add/remove WordPress Hooks (Filters and Actions) to/from functions and methods.
$ composer require piotrpress/wordpress-hooksrequire __DIR__ . '/vendor/autoload.php';#[ Action( string $hook_name, int $priority = 10 ) ]
#[ Filter( string $hook_name, int $priority = 10 ) ]Hooks::add( object $object = null, string $callback = '', PiotrPress\CacheInterface $cache = null ) : void
Hooks::remove( object $object = null, string $callback = '', PiotrPress\CacheInterface $cache = null ) : voidIf object argument is passed and callback is omitted, then all hooks from object are added or removed.
use PiotrPress\WordPress\Hooks;
use PiotrPress\WordPress\Hooks\Action;
use PiotrPress\WordPress\Hooks\Filter;
class Example {
public function add_hooks() {
Hooks::add( $this );
}
#[ Action( 'init' ) ]
public function example_init() : void {
// do something
}
#[ Filter( 'the_title', 1 ) ]
public function example_the_title( string $post_title, int $post_id ) : string {
// do something
}
}
$example = new Example();
$example->add_hooks();
Hooks::remove( $example );This is an equivalent to:
$example = new Example();
add_action( 'init', [ $example, 'example_init' ] );
add_filter( 'the_title', [ $example, 'example_the_title' ], 1, 2 );
remove_action( 'init', [ $example, 'example_init' ] );
remove_filter( 'the_title', [ $example, 'example_the_title' ], 1, 2 );Note: Hooks::add/remove() methods can be called from the method, or even outside the object.
If object and callback arguments are passed, then only hooks for this method are added or removed.
use PiotrPress\WordPress\Hooks;
use PiotrPress\WordPress\Hooks\Action;
use PiotrPress\WordPress\Hooks\Filter;
class Example {
public function add_hooks() {
Hooks::add( $this, 'example_init' );
Hooks::add( $this, 'example_the_title' );
}
#[ Action( 'init' ) ]
public function example_init() : void {
// do something
}
#[ Filter( 'the_title', 1 ) ]
public function example_the_title( string $post_title, int $post_id ) : string {
// do something
}
}
$example = new Example();
$example->add_hooks();
Hooks::remove( $example, 'example_init' );
Hooks::remove( $example, 'example_the_title' );This is an equivalent to:
$example = new Example();
add_action( 'init', [ $example, 'example_init' ] );
add_filter( 'the_title', [ $example, 'example_the_title' ], 1, 2 );
remove_action( 'init', [ $example, 'example_init' ] );
remove_filter( 'the_title', [ $example, 'example_the_title' ], 1, 2 );If object argument is omitted and callback is passed, then only hooks for this function are added or removed.
use PiotrPress\WordPress\Hooks;
use PiotrPress\WordPress\Hooks\Action;
use PiotrPress\WordPress\Hooks\Filter;
#[ Action( 'init' ) ]
public function example_init() : void {
// do something
}
#[ Filter( 'the_title', 1 ) ]
public function example_the_title( string $post_title, int $post_id ) : string {
// do something
}
Hooks::add( callback: 'example_init' );
Hooks::add( callback: 'example_the_title' );
Hooks::remove( callback: 'example_init' );
Hooks::remove( callback: 'example_the_title' );This is an equivalent to:
add_action( 'init', 'example_init' );
add_filter( 'the_title', 'example_the_title', 1, 2 );
remove_action( 'init', 'example_init' );
remove_filter( 'the_title', 'example_the_title', 1, 2 );Optionally, you can pass a cache object, which must implement PiotrPress\CacheInterface interface, as a third cache argument to Hooks::add/remove() methods.
This will cache the result of Hooks::get() method, which provides a list of hooks for a given object, method or function using Reflection API, so caching its result can significantly improve the performance.
use PiotrPress\Cacher;
use PiotrPress\WordPress\Hooks;
use PiotrPress\WordPress\Hooks\Action;
use PiotrPress\WordPress\Hooks\Filter;
class Example {
#[ Action( 'init' ) ]
public function example_init() : void {
// do something
}
#[ Filter( 'the_title', 1 ) ]
public function example_the_title( string $post_title, int $post_id ) : string {
// do something
}
}
$example = new Example();
$cache = new Cacher( '.hooks' );
Hooks::add( object: $example, cache: $cache );
Hooks::remove( object: $example, cache: $cache );Note: You can use simple file-based cache, which is provided by PiotrPress\Cacher library distributed with this library.
Inspirations, feedback, ideas and feature requests provided by:
PHP >= 8.0 version.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent