WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Hook::remove_filter()

WP_Hook::remove_filter( string $hook_name, callable|string|array $callback, int $priority ): bool

In this article

Back to top

Removes a callback function from a filter hook.

Parameters

$hook_namestringrequired
The filter hook to which the function to be removed is hooked.
$callbackcallable|string|arrayrequired
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.
$priorityintrequired
The exact priority used when adding the original filter callback.

Return

bool Whether the callback existed before it was removed.

Source

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 ] );

			$this->priorities = array_keys( $this->callbacks );

			if ( $this->nesting_level > 0 ) {
				$this->resort_active_iterations();
			}
		}
	}

	return $exists;
}

View all references View on Trac View on GitHub

UsesDescription
WP_Hook::resort_active_iterations()wp-includes/class-wp-hook.php

Handles resetting callback priority keys mid-iteration.

_wp_filter_build_unique_id()wp-includes/plugin.php

Builds a unique string ID for a hook callback function.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.