WP_Hook::remove_filter( string $hook_name, callable|string|array $callback, int $priority ): bool
Removes a callback function from a filter hook.
Parameters
-
$hook_namestring Required -
The filter hook to which the function to be removed is hooked.
-
$callbackcallable|string|array Required -
The callback to be removed from running when the filter is applied.
This method can be called unconditionally to speculatively remove a callback that may or may not exist. -
$priorityint 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.
View all references
public function remove_filter( $hook_name, $callback, $priority ) {
$function_key = _wp_filter_build_unique_id( $hook_name, $callback, $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. |