同学们，早上好！今天咱们来聊聊 WordPress 里一个藏得比较深，但又非常关键的函数：_wp_filter_build_unique_id()。 别看它名字挺长，作用可大了，尤其是在你想要移除某个 action 或者 filter 的时候，它能帮你精准定位到目标。
开场白：为什么我们需要唯一的 ID？
想象一下，你在组织一场大型活动，来了很多嘉宾，其中有几个名字都一样，比如都叫“张三”。 如果你想单独通知其中一个张三，你该怎么办？ 总不能喊一声“张三”，所有人都回头吧？
WordPress 的 action 和 filter 机制也是类似的。 你可以给同一个 hook（比如 wp_head）添加多个函数（或者叫 callback）。 如果你想移除其中一个，就需要一个唯一的标识来区分它们。 _wp_filter_build_unique_id() 就是负责生成这个唯一标识的。
函数概览：_wp_filter_build_unique_id() 的作用
_wp_filter_build_unique_id() 的主要任务就是根据给定的 $tag（hook 名称）和 $function_to_add（要添加的函数），生成一个唯一的 ID。 这个 ID 可以让你在之后使用 remove_action() 或 remove_filter() 来移除这个函数。
这个函数最有趣的地方在于它如何处理匿名函数和闭包，因为这些函数没有名字，所以需要一种特殊的方法来生成它们的 ID。
源码剖析：_wp_filter_build_unique_id() 的真面目
让我们直接看代码：
/**
* Build Unique ID for storage and removal of filters.
*
* @since 2.2.3
* @access private
*
* @param string $tag Filter hook.
* @param callable $function_to_add Function to be added.
* @param int $priority Priority number.
* @return string Unique ID for usage in filters array.
*/
function _wp_filter_build_unique_id( $tag, $function_to_add, $priority ) {
static $filter_id_count = 0;
if ( is_string( $function_to_add ) ) {
return $function_to_add;
}
if ( is_object( $function_to_add ) ) {
// Closures are currently implemented as objects
$function_to_add = array( $function_to_add, '' );
} else {
$function_to_add = (array) $function_to_add;
}
if ( is_object( $function_to_add[0] ) ) {
// Object Class Calling
if ( function_exists( 'spl_object_hash' ) ) {
return spl_object_hash( $function_to_add[0] ) . $function_to_add[1];
} else {
$filter_id_count ++;
return spl_object_hash( $function_to_add[0] ) . $function_to_add[1] . '_' . $filter_id_count;
}
} elseif ( is_string( $function_to_add[0] ) ) {
// Static Calling
return $function_to_add[0] . '::' . $function_to_add[1];
}
}我们来逐行解读：
-
static $filter_id_count = 0;： 这是一个静态变量，用来记录已经生成了多少个 ID。 注意，它是静态的，意味着它在函数多次调用之间会保留它的值。 主要用于在不支持spl_object_hash()的情况下，提供一个 fallback 机制，保证ID的唯一性。 -
if ( is_string( $function_to_add ) ) { return $function_to_add; }： 如果$function_to_add是一个字符串，说明它是一个普通的函数名。 直接返回这个函数名作为 ID 就行了。 例如，add_action( 'wp_head', 'my_custom_function' )，那么 ID 就是my_custom_function。 -
if ( is_object( $function_to_add ) ) { $function_to_add = array( $function_to_add, '' ); } else { $function_to_add = (array) $function_to_add; }： 这里处理的是对象和数组的情况。 如果$function_to_add是一个对象（通常是闭包），把它转换成一个数组array( $object, '' )。 如果$function_to_add本身就是一个数组，直接把它强制转换为数组。 这样做的目的是为了统一后续的处理方式，方便提取对象和方法名。 -
if ( is_object( $function_to_add[0] ) ) { ... }： 这是最关键的部分，处理对象方法调用。$function_to_add[0]是对象实例，$function_to_add[1]是方法名。-
if ( function_exists( 'spl_object_hash' ) ) { return spl_object_hash( $function_to_add[0] ) . $function_to_add[1]; }： 如果 PHP 支持spl_object_hash()函数（通常 PHP 5.2 及以上版本都支持），就用它来生成对象实例的唯一哈希值，然后把哈希值和方法名拼接起来作为 ID。spl_object_hash()返回的是一个字符串，代表对象实例的唯一标识。 -
else { $filter_id_count ++; return spl_object_hash( $function_to_add[0] ) . $function_to_add[1] . '_' . $filter_id_count; }： 如果 PHP 不支持spl_object_hash()，那就用静态变量$filter_id_count来生成一个递增的数字，然后把哈希值、方法名和这个数字拼接起来作为 ID。 这种方式虽然也能保证一定程度的唯一性，但不如spl_object_hash()靠谱，毕竟$filter_id_count是全局的，可能会受到其他地方的影响。
-
-
elseif ( is_string( $function_to_add[0] ) ) { return $function_to_add[0] . '::' . $function_to_add[1]; }： 这里处理的是静态方法调用。$function_to_add[0]是类名，$function_to_add[1]是静态方法名。 直接把类名和方法名用::拼接起来作为 ID。 例如，add_action( 'wp_head', array( 'MyClass', 'my_static_method' ) )，那么 ID 就是MyClass::my_static_method。
实战演练：各种情况下的 ID 生成
为了更好地理解这个函数，我们来模拟几种常见的场景，看看它会生成什么样的 ID。
-
普通函数：
function my_custom_function() { echo 'Hello, world!'; } add_action( 'wp_head', 'my_custom_function', 10 );在这种情况下，
_wp_filter_build_unique_id()会直接返回函数名my_custom_function作为 ID。 -
类的方法：
class MyClass { public function my_method() { echo 'Hello from MyClass!'; } } $my_object = new MyClass(); add_action( 'wp_head', array( $my_object, 'my_method' ), 10 );在这种情况下，
_wp_filter_build_unique_id()会先用spl_object_hash()获取$my_object的哈希值，然后把哈希值和方法名my_method拼接起来作为 ID。 例如，如果$my_object的哈希值是00000000abcdef01，那么 ID 就是00000000abcdef01my_method。 -
静态方法：
class MyClass { public static function my_static_method() { echo 'Hello from static MyClass!'; } } add_action( 'wp_head', array( 'MyClass', 'my_static_method' ), 10 );在这种情况下，
_wp_filter_build_unique_id()会把类名MyClass和方法名my_static_method用::拼接起来作为 ID。 所以 ID 就是MyClass::my_static_method。 -
匿名函数（闭包）：
add_action( 'wp_head', function() { echo 'Hello from anonymous function!'; }, 10 );在这种情况下，匿名函数会被当做一个对象处理，
_wp_filter_build_unique_id()会先用spl_object_hash()获取匿名函数的哈希值，然后把哈希值和一个空字符串拼接起来作为 ID。 例如，如果匿名函数的哈希值是00000000fedcba98，那么 ID 就是00000000fedcba98。
移除 Action/Filter：remove_action() 和 remove_filter() 的幕后英雄
现在我们知道了 _wp_filter_build_unique_id() 如何生成 ID，接下来看看它在 remove_action() 和 remove_filter() 中扮演的角色。
remove_action() 和 remove_filter() 的基本用法是：
remove_action( $tag, $function_to_remove, $priority );
remove_filter( $tag, $function_to_remove, $priority );$tag：要移除的 action/filter 的 hook 名称。$function_to_remove：要移除的函数。$priority：要移除的函数的优先级。
当我们调用 remove_action() 或 remove_filter() 时，WordPress 内部会调用 _wp_filter_build_unique_id() 来生成要移除的函数的 ID。 然后，它会在存储 action/filter 的全局数组中查找这个 ID，如果找到了，就把它从数组中移除。
案例分析：移除匿名函数
移除匿名函数是 _wp_filter_build_unique_id() 最能体现价值的地方。 因为匿名函数没有名字，所以我们不能直接用函数名来移除它。 我们需要先获取它的 ID，然后才能移除它。
// 添加匿名函数
$anonymous_function = function() {
echo 'Hello from anonymous function!';
};
add_action( 'wp_head', $anonymous_function, 10 );
// 移除匿名函数
remove_action( 'wp_head', $anonymous_function, 10 );在上面的代码中，我们先把匿名函数赋值给变量 $anonymous_function，然后再把它添加到 wp_head 这个 hook 上。 移除的时候，我们直接把 $anonymous_function 传给 remove_action()，_wp_filter_build_unique_id() 会自动生成正确的 ID，然后移除这个匿名函数。
注意事项：坑和陷阱
-
大小写敏感： 函数名是大小写敏感的。 如果你添加的时候用的是
MyFunction，移除的时候用的是myfunction，那就没用了。 -
优先级必须匹配：
remove_action()和remove_filter()的优先级参数必须和添加的时候完全一致才能移除成功。 -
对象实例必须相同： 如果你用不同的对象实例添加了同一个方法，那么移除的时候也需要使用相同的对象实例。
-
在正确的时机移除： 确保在 action/filter 被添加之后再移除它。 如果在添加之前就尝试移除，是不会有任何效果的。
表格总结：各种情况下的 ID 生成规则
| 函数类型 | $function_to_add 类型 |
ID 生成规则 | 示例 |
|---|---|---|---|
| 普通函数 | string |
直接使用函数名作为 ID。 | my_custom_function |
| 类的方法 | array(object, string) |
如果支持 spl_object_hash()，则使用 spl_object_hash($object) . $method_name 作为 ID。 否则，使用 spl_object_hash($object) . $method_name . '_' . $filter_id_count 作为 ID。 |
00000000abcdef01my_method (假设 spl_object_hash 返回此值) |
| 静态方法 | array(string, string) |
使用 class_name . '::' . $method_name 作为 ID。 |
MyClass::my_static_method |
| 匿名函数（闭包） | object |
如果支持 spl_object_hash()，则使用 spl_object_hash($anonymous_function) 作为 ID。 否则，使用 spl_object_hash($anonymous_function) . '_' . $filter_id_count 作为 ID。 |
00000000fedcba98 (假设 spl_object_hash 返回此值) |
高级技巧：调试 ID 生成
如果你不确定某个 action/filter 的 ID 是什么，可以用以下方法来调试：
-
手动调用
_wp_filter_build_unique_id()： 在你的代码中手动调用_wp_filter_build_unique_id()，传入相应的参数，然后把返回值打印出来。$tag = 'wp_head'; $function_to_add = function() { echo 'Hello'; }; $priority = 10; $id = _wp_filter_build_unique_id( $tag, $function_to_add, $priority ); echo 'ID: ' . $id; -
使用
has_action()或has_filter()结合调试：has_action()和has_filter()可以用来判断某个 action/filter 是否存在。 你可以结合调试语句，逐步缩小范围，找到目标 action/filter 的 ID。
总结：_wp_filter_build_unique_id() 的重要性
_wp_filter_build_unique_id() 虽然看起来只是一个小小的工具函数，但它却是 WordPress action 和 filter 机制中不可或缺的一部分。 它保证了我们可以精确地添加和移除 action/filter，即使是匿名函数和闭包也能轻松应对。 理解了这个函数的工作原理，可以让你更好地掌握 WordPress 的扩展机制，写出更灵活、更健壮的代码。
好了，今天的讲座就到这里。 感谢大家的参与！希望大家对 _wp_filter_build_unique_id() 有了更深入的了解。下次遇到移除 action/filter 的问题，相信你一定能游刃有余！下次再见!