WP_Hook::remove_filter

Advertisement

Summery Summery

Unhooks a function or method from a specific filter action.

Syntax Syntax

WP_Hook::remove_filter( string $tag, callable $function_to_remove, int $priority )

Parameters Parameters

$tag

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

$function_to_remove

(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.

Return Return

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

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

Advertisement

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

What are you looking for?