WP_Hook::remove_filter( string $hook_name, callable|string|array $callback, int $priority )
Removes a callback function from a filter hook.
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 method can be called unconditionally to speculatively remove a callback that may or may not exist.
- $priority
-
(Required) The exact priority used when adding the original filter callback.
Return
(bool) Whether the callback existed before it was removed.
Source
File: wp-includes/class-wp-hook.php
public function remove_filter( $tag, $function_to_remove, $priority ) {
$function_key = _wp_filter_build_unique_id( $tag, $function_to_remove, $priority );
$exists = isset( $this->callbacks[ $priority ][ $function_key ] );
if ( $exists ) {
unset( $this->callbacks[ $priority ][ $function_key ] );
if ( ! $this->callbacks[ $priority ] ) {
unset( $this->callbacks[ $priority ] );
if ( $this->nesting_level > 0 ) {
$this->resort_active_iterations();
}
}
}
return $exists;
}
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |