remove_action( string $hook_name, callable|string|array $callback, int $priority = 10 ): bool
Removes a callback function from an action hook.
Contents
Description
This can be used to remove default functions attached to a specific action hook and possibly replace them with a substitute.
To remove a hook, the $callback
and $priority
arguments must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.
Parameters
-
$hook_name
string Required -
The action hook to which the function to be removed is hooked.
-
$callback
callable|string|array Required -
The name of the function which should be removed.
This function can be called unconditionally to speculatively remove a callback that may or may not exist. -
$priority
int Optional -
The exact priority used when adding the original action callback.
Default:
10
Return
bool Whether the function is removed.
More Information
- This function is an alias to remove_filter() .
- See also add_action() and add_filter() .
- To remove a hook, the $function_to_remove and $priority arguments must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.
Source
File: wp-includes/plugin.php
.
View all references
function remove_action( $hook_name, $callback, $priority = 10 ) {
return remove_filter( $hook_name, $callback, $priority );
}
Changelog
Version | Description |
---|---|
1.2.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
This function is identical to the remove_filter() function.
remove_action() must be called inside a function and cannot be called directly in your plugin or theme.
If an action has been added from within a class, for example by a plugin, removing it will require accessing the class through a variable that holds the class instance.
Unless the function is static in which case you could call the class and function directly.
Notes:
If you need to be able to remove an action/filter for a class object you do not have access to, you can do so with this function (which includes support for WordPress 4.7+):
https://gist.github.com/tripflex/c6518efc1753cf2392559866b4bd1a53
Top ↑
Feedback
This is a great function and works a charm. Thanks to this. — By ProServ —
The old codex contains this very important note that unfortunately didn’t make it into this page:
Important: To remove a hook, the
$function_to_remove
and$priority arguments
must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.Related:
do_action()
add_action()