tombroucke / wp-fluent-hooks
A small utility package that provides a modern, fluent interface for adding WordPress action and filter hooks. Chain methods to build your hooks in a more expressive and readable way.
Requires
- php: >=8.0
Requires (Dev)
- brain/monkey: ^2.7
- laravel/pint: ^1.29
- pestphp/pest: ^4.6
- phpstan/phpstan: ^2.1
- szepeviktor/phpstan-wordpress: ^2.0
This package is auto-updated.
Last update: 2026-06-19 08:00:22 UTC
README
A fluent interface for registering and deregistering WordPress filters and actions. Instead of repeating the hook name across multiple add_filter() and remove_filter() calls, you chain everything together. This makes your hook logic easier to read and maintain.
// Before remove_filter('woocommerce_before_shop_loop', 'woocommerce_result_count', 20); remove_filter('woocommerce_before_shop_loop', 'woocommerce_catalog_ordering', 30); // After Action::hook('woocommerce_before_shop_loop') ->deregister('woocommerce_result_count', 20) ->deregister('woocommerce_catalog_ordering', 30);
Examples
Filters
Filter::hook('the_title') ->register(fn ($title) => strtoupper($title));
With priority and argument count:
Filter::hook('save_post') ->register(function ($postId, $post, $update) { // Do something }, priority: 11, args: 3);
Actions
Action and Filter share the same API and can be used interchangeably.
Action::hook('init') ->register(function () { // Do something });
Deregistering
Deregister external hooks by passing the callback name and priority inline:
Action::hook('woocommerce_before_shop_loop') ->deregister('woocommerce_result_count', 20) ->deregister('woocommerce_catalog_ordering', 30);
Chain deregistering and registering on the same hook. Use chainable methods priority() and args() to set values for the rest of the chain:
Action::hook('woocommerce_before_main_content') ->priority(20) ->deregister('woocommerce_breadcrumb') ->register(function () { yoast_breadcrumb('<p class="small breadcrumb">', '</p>'); });
Conditional registration
Use when() to conditionally run a registered callback. The condition receives the same arguments as the filter/action and is evaluated at the time the hook fires
Filter::hook('the_title') ->when(fn ($title) => strlen($title) > 10) ->register(fn ($title) => strtoupper($title));
Use always() to remove a previously set condition:
Filter::hook('the_title') ->when(fn ($title) => strlen($title) > 10) ->register(fn ($title) => strtoupper($title)) ->always() ->register(fn ($title) => strtolower($title));
when()currently cannot be combined withderegister(). You will need to find a workaround for now.
Deferring to another hook
Use at() to defer register() or deregister() until another hook fires. This is useful when the context you need (e.g. the current post, the current page) is not yet available at the time your code runs.
When a plugin or theme nests the actions and filters
add_action('template_redirect', function () { add_filter('the_title', 'strtoupper'); }, 100);
You can
Filter::hook('the_title') ->at('template_redirect', 101) ->deregister('strtoupper');
Aliases
Only hooks registered with an alias are tracked internally. Without an alias, the hook is registered with WordPress but cannot be deregistered via this library. Assign an alias to reference a hook registered via this library:
Action::hook('body_class') ->alias('my_custom_body_class') ->register(fn ($classes) => array_merge($classes, ['custom-class'])); // Later: Action::hook('body_class') ->deregister('my_custom_body_class');