wordpress / latest / functions / has_filter.html

has_filter( string $hook_name, callable|string|array|false $callback = false ): bool|int

Checks if any filter has been registered for a hook.

Description

When using the $callback argument, this function may return a non-boolean value that evaluates to false (e.g. 0), so use the === operator for testing the return value.

Parameters

$hook_name string Required
The name of the filter hook.
$callback callable|string|array|false Optional
The callback to check for.
This function can be called unconditionally to speculatively check a callback that may or may not exist.

Default: false

Return

bool|int If $callback is omitted, returns boolean for whether the hook has anything registered. When checking a specific function, the priority of that hook is returned, or false if the function is not attached.

Source

File: wp-includes/plugin.php. View all references

function has_filter( $hook_name, $callback = false ) {
	global $wp_filter;

	if ( ! isset( $wp_filter[ $hook_name ] ) ) {
		return false;
	}

	return $wp_filter[ $hook_name ]->has_filter( $hook_name, $callback );
}

Used By

Used By Description

Changelog

Version Description
2.5.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/has_filter