A WordPress-centric search engine for devs and theme authors



_wp_filter_build_unique_id ›

Since2.2.3
Deprecatedn/a
_wp_filter_build_unique_id ( $tag, $function, $priority )
Access:
  • private
Parameters: (3)
  • (string) $tag Unused. The name of the filter to build ID for.
    Required: Yes
  • (callable) $function The function to generate ID for.
    Required: Yes
  • (int) $priority Unused. The order in which the functions associated with a particular action are executed.
    Required: Yes
Links:
Returns:
  • (string) Unique function ID for usage as array key.
Defined at:
Codex:
Change Log:
  • 5.3.0

Build Unique ID for storage and retrieval.

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.


Source

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

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

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