剖析 `_wp_filter_build_unique_id()` 函数的源码，它如何为钩子函数生成唯一的 ID 以防止重复添加？ - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，大家好！欢迎来到今天的“WordPress钩子函数唯一ID生成机制剖析”讲座。今天咱们不谈风花雪月，就聊聊这WordPress背地里的小九九，特别是_wp_filter_build_unique_id()这个函数，它就像个老中医，专治各种钩子函数“撞脸”的毛病。

开场白：钩子函数的“身份证”问题

在WordPress的世界里，钩子函数（Actions 和 Filters）是核心机制之一，允许开发者在不修改核心代码的情况下，扩展或修改WordPress的行为。但问题来了，如果多个插件或主题都想对同一个钩子做点什么，怎么办？怎么区分这些“好心人”呢？这就引出了“唯一ID”的概念。

简单来说，每个注册到某个钩子的函数都需要一个唯一的身份证，这样WordPress才能准确地知道哪个函数应该执行，以及执行的顺序。如果没有这个“身份证”，两个完全相同的函数（包括函数名和参数）就会被认为是同一个，导致后面的注册无效。 _wp_filter_build_unique_id() 的任务就是生成这个“身份证”。

正文：解剖 _wp_filter_build_unique_id() 的源码

咱们直接上代码，看看这老中医的药方：

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 sprintf( '%s-%s-%d', get_class( $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。它的作用稍后会解释。静态变量在函数多次调用时保持其值不变。
if ( is_string( $function_to_add ) ) { return $function_to_add; }

这是最简单的情况。如果传入的 $function_to_add 本身就是一个字符串（通常是函数名），那么直接返回这个字符串。这意味着，如果注册钩子时直接使用函数名字符串，这个函数名就会被当做唯一ID。

举个栗子：
```
add_action( 'wp_head', 'my_custom_function' );
```
在这种情况下，_wp_filter_build_unique_id() 就会直接返回 'my_custom_function'。
if ( is_object( $function_to_add ) ) { ... } else { ... }

这里开始处理复杂的情况，判断 $function_to_add 是不是一个对象。如果是对象，说明你可能用的是匿名函数（Closure）或者对象的方法。如果不是对象，就把它强制转换成数组。

匿名函数（Closure）在PHP中被实现为对象，所以会被归类到 is_object 的分支。
```
add_action( 'wp_head', function() { echo 'Hello!'; } ); // 匿名函数
```
或者：
```
class MyClass {
    public function my_method() {
        echo 'Hello from MyClass!';
    }
}

$my_object = new MyClass();
add_action( 'wp_head', array( $my_object, 'my_method' ) ); // 对象方法
```
如果是数组，说明你可能用的是类静态方法，或者普通的对象方法。
if ( is_object( $function_to_add[0] ) ) { ... }

如果 $function_to_add 是一个数组，并且数组的第一个元素是一个对象，那么说明你调用的是对象的方法。
- if ( function_exists( 'spl_object_hash' ) ) { ... }
  
  spl_object_hash() 是一个PHP内置函数，用于生成对象的唯一哈希值。如果服务器支持这个函数，就用它来生成ID，哈希值可以保证唯一性。对象的哈希值与对象实例关联，即使两个对象的属性完全相同，它们的哈希值也不同。
  
  最终生成的ID是 spl_object_hash( $function_to_add[0] ) . $function_to_add[1]，也就是对象的哈希值加上方法名。
- else { ... }
  
  如果服务器不支持 spl_object_hash()，那就只能用老办法了。使用静态变量 $filter_id_count 计数，并结合类名和方法名生成ID。
  
  最终生成的ID是 sprintf( '%s-%s-%d', get_class( $function_to_add[0] ), $function_to_add[1], $filter_id_count )，也就是类名-方法名-计数器。
  
  注意： 这种方法在某些情况下可能会导致ID冲突，特别是当多个对象属于同一个类，并且都使用相同的方法名注册到同一个钩子时。这是因为计数器是全局的，如果两个对象在很短的时间内注册，计数器的值可能相同。
elseif ( is_string( $function_to_add[0] ) ) { ... }

如果 $function_to_add 是一个数组，并且数组的第一个元素是一个字符串，那么说明你调用的是类的静态方法。

最终生成的ID是 $function_to_add[0] . '::' . $function_to_add[1]，也就是类名::方法名。

举个栗子：
```
class MyClass {
    public static function my_static_method() {
        echo 'Hello from static method!';
    }
}

add_action( 'wp_head', array( 'MyClass', 'my_static_method' ) ); // 静态方法
```
在这种情况下，_wp_filter_build_unique_id() 就会返回 'MyClass::my_static_method'。

总结：_wp_filter_build_unique_id() 的策略

咱们用一个表格来总结一下 _wp_filter_build_unique_id() 的策略：

函数类型	生成ID的方式	备注
函数名字符串	直接返回函数名	最简单的情况
对象方法	`spl_object_hash(object) . method_name` (如果支持 `spl_object_hash`)	使用对象哈希值和方法名，确保唯一性。如果不支持`spl_object_hash`，则使用 `get_class(object) . method_name . 计数器`，可能会有冲突风险。
匿名函数 (Closure)	`spl_object_hash(object) . ''` (如果支持 `spl_object_hash`)	匿名函数在PHP中被视为对象
静态方法	`class_name . '::' . method_name`	类名和方法名结合

案例分析：避免ID冲突

咱们来模拟一个可能出现ID冲突的场景，并看看如何避免：

假设有两个插件，都定义了同一个类，并且都用这个类的实例注册了同一个钩子：

插件A:

class MyClass {
    public function my_method() {
        echo 'Hello from Plugin A!';
    }
}

$my_object_a = new MyClass();
add_action( 'wp_head', array( $my_object_a, 'my_method' ) );

插件B:

class MyClass {
    public function my_method() {
        echo 'Hello from Plugin B!';
    }
}

$my_object_b = new MyClass();
add_action( 'wp_head', array( $my_object_b, 'my_method' ) );

如果服务器不支持 spl_object_hash()，那么这两个插件生成的ID很可能会是 'MyClass-my_method-1' 和 'MyClass-my_method-2'，导致后注册的插件B的钩子函数无法执行。

如何避免呢？

使用不同的类名： 这是最简单直接的方法。插件A和插件B使用不同的类名，例如 MyClassA 和 MyClassB。
使用匿名函数： 将方法封装在匿名函数中，这样每次注册的都是不同的匿名函数对象。

插件A:
```
class MyClass {
    public function my_method() {
        echo 'Hello from Plugin A!';
    }
}

$my_object_a = new MyClass();
add_action( 'wp_head', function() use ( $my_object_a ) {
    $my_object_a->my_method();
} );
```
插件B:
```
class MyClass {
    public function my_method() {
        echo 'Hello from Plugin B!';
    }
}

$my_object_b = new MyClass();
add_action( 'wp_head', function() use ( $my_object_b ) {
    $my_object_b->my_method();
} );
```
这样，即使类名和方法名相同，每次注册的都是不同的匿名函数对象，spl_object_hash() (如果支持) 会生成不同的哈希值，确保ID的唯一性。如果不支持spl_object_hash()，每次注册的也是不同的匿名函数对象，所以静态变量会递增，也能生成不同的ID。
手动指定优先级： 尽管不能直接改变ID生成方式，但可以通过指定不同的优先级来控制执行顺序。优先级高的函数会先执行。

高级话题：remove_action() 和 remove_filter()

理解了ID的生成机制，对于理解 remove_action() 和 remove_filter() 的工作方式也很有帮助。这两个函数都需要知道要移除的钩子函数的ID，才能正确地移除。

remove_action( $tag, $function_to_remove, $priority );
remove_filter( $tag, $function_to_remove, $priority );

$tag: 钩子的名称。
$function_to_remove: 要移除的函数。
$priority: 优先级。

重点： $function_to_remove 必须与注册时使用的完全一致，包括函数名、对象实例、类名等。如果ID不匹配，remove_action() 和 remove_filter() 将无法正常工作。

举个栗子：

class MyClass {
    public function my_method() {
        echo 'Hello!';
    }
}

$my_object = new MyClass();
add_action( 'wp_head', array( $my_object, 'my_method' ), 10 );

// 正确的移除方式：
remove_action( 'wp_head', array( $my_object, 'my_method' ), 10 );

// 错误的移除方式：
$another_object = new MyClass(); // 创建了新的对象
remove_action( 'wp_head', array( $another_object, 'my_method' ), 10 ); // 移除失败，因为对象实例不同

在这个例子中，即使两个对象都属于 MyClass，它们也是不同的实例，spl_object_hash() 会生成不同的哈希值。所以，只有使用相同的对象实例才能正确移除钩子。

总结：_wp_filter_build_unique_id() 的重要性

_wp_filter_build_unique_id() 函数虽然看起来不起眼，但它在WordPress的钩子机制中扮演着至关重要的角色。它负责为每个钩子函数生成唯一的ID，防止重复添加，确保钩子函数能够按照预期执行。理解了这个函数的原理，可以帮助我们更好地理解WordPress的钩子机制，编写更健壮的插件和主题。

最后的忠告：

在注册钩子函数时，尽量使用函数名字符串，这样最简单直接。
如果使用对象方法或匿名函数，要确保服务器支持 spl_object_hash()，以获得更好的唯一性保障。
在移除钩子函数时，务必使用与注册时完全相同的参数，包括函数名、对象实例、类名等。
遇到ID冲突问题时，可以尝试使用不同的类名、匿名函数或手动指定优先级来解决。

好了，今天的讲座就到这里。希望各位观众老爷们以后在写WordPress插件和主题的时候，能够更加得心应手，避免踩坑。感谢大家的收听！下次再见！

发表回复 取消回复

发表回复取消回复