_wp_filter_build_unique_id( string $hook_name, callable $callback, int $priority )

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Builds Unique ID for storage and retrieval.

Description

The old way to serialize the callback caused issues and this function is the solution. It works by checking for objects and creating a new property in the class to keep track of the object and new objects of the same class that need to be added.

It also allows for the removal of actions and filters for objects after they change class properties. It is possible to include the property $wp_filter_id in your class and set it to "null" or a number to bypass the workaround. However this will prevent you from adding new classes and any new classes will overwrite the previous hook by the same class.

Functions and static method callbacks are just returned as strings and shouldn’t have any speed penalty.

Parameters

$hook_name

(string) (Required) Unused. The name of the filter to build ID for.

$callback

(callable) (Required) The function to generate ID for.

$priority

(int) (Required) Unused. The order in which the functions associated with a particular action are executed.

Return

(string) Unique function ID for usage as array key.

Source

File: wp-includes/plugin.php 

function _wp_filter_build_unique_id( $hook_name, $callback, $priority ) {
	if ( is_string( $callback ) ) {
		return $callback;
	}

	if ( is_object( $callback ) ) {
		// Closures are currently implemented as objects.
		$callback = array( $callback, '' );
	} else {
		$callback = (array) $callback;
	}

	if ( is_object( $callback[0] ) ) {
		// Object class calling.
		return spl_object_hash( $callback[0] ) . $callback[1];
	} elseif ( is_string( $callback[0] ) ) {
		// Static calling.
		return $callback[0] . '::' . $callback[1];
	}
}

Used By

Used By Description
wp-includes/class-wp-hook.php: WP_Hook::add_filter()

Adds a callback function to a filter hook.
wp-includes/class-wp-hook.php: WP_Hook::remove_filter()

Removes a callback function from a filter hook.
wp-includes/class-wp-hook.php: WP_Hook::has_filter()

Checks if a specific callback has been registered for this hook.

Changelog

Version Description
5.3.0 Removed workarounds for spl_object_hash(). $hook_name and $priority are no longer used, and the function always returns a string.
2.2.3 Introduced.

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