分析 WordPress `_wp_filter_build_unique_id()` 函数源码：如何为匿名函数和闭包生成唯一的钩子 ID。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，大家好！我是今天的主讲人，咱们今天聊聊WordPress里一个特别容易被人忽略，但是又特别重要的函数：_wp_filter_build_unique_id()。这函数主要负责给那些没有名字的函数，也就是匿名函数和闭包，生成一个独一无二的ID。这ID在WordPress的钩子（Hook）系统中至关重要，因为只有有了唯一ID，你才能准确地添加、移除或修改特定钩子上的回调函数。

好，废话不多说，直接上干货！

一、钩子系统与匿名函数的困境

首先，咱们简单回顾一下WordPress的钩子系统。这玩意儿允许开发者在不修改核心代码的情况下，扩展或修改WordPress的功能。它就像是WordPress代码中的一些“挂钩点”，你可以在这些点上“挂”上你自己的函数，当WordPress执行到这些点的时候，就会顺带执行你的函数。

// 添加一个动作钩子
add_action( 'wp_footer', function() {
    echo '<p>Hello from the footer!</p>';
});

上面的代码就是一个典型的例子，我们使用 add_action 函数，将一个匿名函数“挂”在了 wp_footer 这个动作钩子上。当WordPress渲染页面底部的时候，就会执行这个匿名函数，输出一段问候语。

问题来了，如果我想移除这个匿名函数怎么办？remove_action 函数需要知道你要移除哪个函数，而匿名函数没有名字，这可咋整？

// 错误的移除方式 (不起作用)
remove_action( 'wp_footer', function() {
    echo '<p>Hello from the footer!</p>';
});

上面的代码是行不通的，因为 remove_action 函数需要一个唯一的标识符来找到你要移除的函数。这就引出了我们今天的主角：_wp_filter_build_unique_id() 函数。

二、_wp_filter_build_unique_id() 函数源码剖析

让我们直接深入源码，看看这个函数是如何工作的。这个函数位于 wp-includes/plugin.php 文件中。

/**
 * Build Unique ID for storage and retrieval.
 *
 * The return value is MD5'd for ease of storage, retrieval,
 * and comparison.
 *
 * @since 2.2.3
 * @access private
 *
 * @param string $tag The name of the filter to hook the $function_to_add to.
 * @param callable $function_to_add The function to be connected to the filter.
 * @param int $priority The priority at which the function should be executed.
 * @return string Unique ID for usage in the $wp_filter 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 md5( spl_object_hash( $function_to_add[0] ) . $function_to_add[1] . $priority );
        } else {
            $filter_id_count ++;
            return md5( $filter_id_count . $function_to_add[1] . $priority );
        }
    } elseif ( is_string( $function_to_add[0] ) ) {
        // Static Calling
        return md5( $function_to_add[0] . $function_to_add[1] . $priority );
    }
}

接下来，咱们一行一行地解读这个函数：

static $filter_id_count = 0;: 这是一个静态变量，用于在无法使用 spl_object_hash 函数时生成唯一ID。每次调用这个函数，并且需要用到这个静态变量的时候，它都会自增。
if ( is_string( $function_to_add ) ) { return $function_to_add; }: 如果传入的 $function_to_add 本身就是一个字符串，说明它是一个函数名，直接返回这个函数名即可。这种情况通常用于普通的函数调用，而不是匿名函数或闭包。
if ( is_object( $function_to_add ) ) { $function_to_add = array( $function_to_add, '' ); } else { $function_to_add = (array) $function_to_add; }: 这里对 $function_to_add 进行类型转换。如果 $function_to_add 是一个对象（通常是闭包），则将其转换为一个数组，数组的第一个元素是对象本身，第二个元素是空字符串。如果 $function_to_add 不是对象，则将其强制转换为数组。这一步是为了统一处理各种函数类型，方便后续操作。
if ( is_object( $function_to_add[0] ) ) { ... }: 如果数组的第一个元素是一个对象，说明这是一个对象方法调用或者闭包。
- if ( function_exists( 'spl_object_hash' ) ) { return md5( spl_object_hash( $function_to_add[0] ) . $function_to_add[1] . $priority ); }: 如果存在 spl_object_hash 函数（PHP 5.2.0+），则使用该函数生成对象的唯一哈希值，然后将哈希值、方法名（$function_to_add[1]，如果是闭包则为空字符串）和优先级 $priority 拼接起来，最后使用 md5 函数生成最终的唯一ID。spl_object_hash 函数可以为每个对象生成一个唯一的哈希值，即使是两个内容完全相同的闭包，它们的哈希值也是不同的。
- else { $filter_id_count ++; return md5( $filter_id_count . $function_to_add[1] . $priority ); }: 如果不存在 spl_object_hash 函数，则使用静态变量 $filter_id_count 生成唯一ID。每次调用该函数，$filter_id_count 都会自增，确保生成的ID是唯一的。然后将 $filter_id_count、方法名（$function_to_add[1]）和优先级 $priority 拼接起来，最后使用 md5 函数生成最终的唯一ID。注意，这种方式在并发环境下可能会出现ID冲突，因此尽量使用PHP 5.2.0+版本，避免使用这种备用方案。
elseif ( is_string( $function_to_add[0] ) ) { return md5( $function_to_add[0] . $function_to_add[1] . $priority ); }: 如果数组的第一个元素是一个字符串，说明这是一个静态方法调用。将类名（$function_to_add[0]）、方法名（$function_to_add[1]）和优先级 $priority 拼接起来，最后使用 md5 函数生成最终的唯一ID。

三、生成ID的逻辑梳理

为了方便理解，我把_wp_filter_build_unique_id() 函数生成ID的逻辑整理成一个表格：

函数类型	条件	生成ID的方式
普通函数	`$function_to_add` 是字符串	直接返回函数名
闭包/对象方法	`$function_to_add` 是对象	1. 如果存在 `spl_object_hash` 函数，则使用 `md5( spl_object_hash( $function_to_add[0] ) . $function_to_add[1] . $priority )` 生成ID。 2. 如果不存在 `spl_object_hash` 函数，则使用 `md5( $filter_id_count . $function_to_add[1] . $priority )` 生成ID，并递增 `$filter_id_count`。
静态方法	`$function_to_add[0]` 是字符串	使用 `md5( $function_to_add[0] . $function_to_add[1] . $priority )` 生成ID

四、实战演练：移除匿名函数

现在，我们回到最开始的问题：如何移除一个匿名函数？答案是：在添加匿名函数的时候，手动生成一个唯一ID，并在移除的时候使用这个ID。

// 添加匿名函数
$anonymous_function = function() {
    echo '<p>Hello from the footer!</p>';
};

$unique_id = md5( uniqid( rand(), true ) ); // 生成一个随机的唯一ID
add_action( 'wp_footer', $anonymous_function, 10, $unique_id );

// 移除匿名函数
remove_action( 'wp_footer', $anonymous_function, 10, $unique_id );

上面的代码中，我们首先使用 md5( uniqid( rand(), true ) ) 生成一个随机的唯一ID。然后，在 add_action 函数中，将这个ID作为第四个参数传递进去。最后，在 remove_action 函数中，也使用这个ID来移除匿名函数。

重要提示： 虽然上面的方法可以移除匿名函数，但是它并不是WordPress官方推荐的做法。WordPress的钩子系统内部已经实现了ID生成机制，我们应该尽量使用官方的机制来管理钩子。

更好的方法：使用类方法或静态方法

与其使用匿名函数，不如使用类方法或静态方法。这样，我们就可以直接使用方法名作为ID，方便添加和移除钩子。

class My_Footer_Class {
    public static function my_footer_function() {
        echo '<p>Hello from the footer!</p>';
    }
}

// 添加钩子
add_action( 'wp_footer', array( 'My_Footer_Class', 'my_footer_function' ) );

// 移除钩子
remove_action( 'wp_footer', array( 'My_Footer_Class', 'my_footer_function' ) );

上面的代码中，我们定义了一个 My_Footer_Class 类，并在其中定义了一个静态方法 my_footer_function。然后，我们使用 add_action 函数将这个静态方法挂载到 wp_footer 钩子上。最后，我们使用 remove_action 函数将这个静态方法从 wp_footer 钩子上移除。

五、总结与最佳实践

_wp_filter_build_unique_id() 函数是WordPress钩子系统的重要组成部分，它负责为匿名函数和闭包生成唯一的ID。理解这个函数的工作原理，可以帮助我们更好地管理和使用WordPress的钩子系统。

以下是一些最佳实践：

尽量避免使用匿名函数。 匿名函数虽然方便，但是难以管理。尽量使用类方法或静态方法代替匿名函数。
如果必须使用匿名函数，请手动生成唯一ID。 在添加匿名函数的时候，手动生成一个随机的唯一ID，并在移除的时候使用这个ID。
使用 spl_object_hash 函数生成对象ID。 如果你的PHP版本支持 spl_object_hash 函数，请使用它来生成对象的唯一哈希值。
注意ID冲突问题。 在并发环境下，使用静态变量生成ID可能会导致ID冲突。尽量避免使用这种方式。
阅读源码，理解原理。 深入阅读WordPress的源码，可以帮助你更好地理解WordPress的工作原理，从而编写出更高效、更可靠的代码。

六、进阶思考

_wp_filter_build_unique_id函数使用了md5进行哈希，这在安全性上是否有潜在风险？能否使用更安全的哈希算法？
在WordPress的大型项目中，大量的钩子和回调函数可能会导致性能问题。如何优化钩子系统的性能？比如，可以考虑使用缓存机制来存储钩子的回调函数。
WordPress的钩子系统是否可以扩展，以支持更复杂的钩子类型？例如，可以考虑添加支持参数校验、事务处理等功能的钩子。

好啦，今天的讲座就到这里。希望大家通过今天的学习，对WordPress的钩子系统有了更深入的了解。记住，学无止境，要不断探索，才能成为真正的WordPress大师！感谢各位观众老爷的捧场！下次再见!

发表回复 取消回复

发表回复取消回复