remove_filter( string $hook_name, callable|string|array $callback, int $priority = 10 )
Removes a callback function from a filter hook.
Description
This can be used to remove default functions attached to a specific filter 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
-
(Required) The filter hook to which the function to be removed is hooked.
- $callback
-
(Required) The callback to be removed from running when the filter is applied.<br> This function can be called unconditionally to speculatively remove a callback that may or may not exist.
- $priority
-
(Optional) The exact priority used when adding the original filter callback.
Default value: 10
Return
(bool) Whether the function existed before it was removed.
Source
File: wp-includes/plugin.php
function remove_filter( $tag, $function_to_remove, $priority = 10 ) {
global $wp_filter;
$r = false;
if ( isset( $wp_filter[ $tag ] ) ) {
$r = $wp_filter[ $tag ]->remove_filter( $tag, $function_to_remove, $priority );
if ( ! $wp_filter[ $tag ]->callbacks ) {
unset( $wp_filter[ $tag ] );
}
}
return $r;
}
Changelog
| Version | Description |
|---|---|
| 1.2.0 | Introduced. |