remove_action( string $hook_name, callable $callback, int $priority = 10 )
Removes a callback function from an action hook.
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) (Required) The name of the function which should be removed.
- $priority
-
(int) (Optional) The exact priority used when adding the original action callback.
Default value: 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
function remove_action( $hook_name, $callback, $priority = 10 ) { return remove_filter( $hook_name, $callback, $priority ); }
Changelog
Version | Description |
---|---|
1.2.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/remove_action