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

Removes a callback function from a filter hook.


Parameters Parameters

$hook_name

(string) (Required) The filter hook to which the function to be removed is hooked.

$callback

(callable) (Required) The callback to be removed from running when the filter is applied.

$priority

(int) (Required) The exact priority used when adding the original filter callback.


Top ↑

Return Return

(bool) Whether the callback existed before it was removed.


Top ↑

Source Source

File: wp-includes/class-wp-hook.php

	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;
	}


Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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