分析 `_wp_filter_build_unique_id()` 函数的源码，它是如何为匿名函数和闭包生成唯一 ID 的？

各位朋友，晚上好！我是老码，今天咱们聊聊 WordPress 源码里一个挺有意思的小家伙：_wp_filter_build_unique_id() 函数。别看名字长，作用可不小，专门负责给那些“没名没姓”的匿名函数和闭包生成唯一的身份证号。为啥要给它们生成身份证号？因为 WordPress 的钩子系统（Actions 和 Filters）需要一种可靠的方式来识别和管理这些函数，尤其是当你需要移除某个特定的钩子时。

咱们先来看看这个函数的源码（基于 WordPress 6.4.3）：

<?php
/**
 * Generates a unique function ID for usage with filters.
 *
 * @since 2.5.0
 *
 * @param string|object $tag             The name of the filter to hook the $function_to_add to.
 * @param callable      $function_to_add The function to be added.
 * @param int           $priority        The priority to assign to the function.
 * @return string A unique function ID for usage in filters.
 */
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 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];
    }
}

好家伙，代码不多，但信息量挺大。咱们一步一步来拆解。

1. 函数签名和参数

首先，函数接受三个参数：

• $tag: 钩子的名称，也就是你要挂载函数的“位置”。例如，'the_content'，表示文章内容。
• $function_to_add: 要添加的函数。这可是重点，可以是字符串（函数名）、数组（类的方法）或者对象（闭包）。
• $priority: 优先级，数字越小优先级越高。

返回值是一个字符串，代表这个函数的唯一 ID。

2. 静态变量 $filter_id_count

static $filter_id_count = 0;

这个变量是关键。它是一个静态变量，意味着在函数的多次调用中，它的值会被保留。你可以把它想象成一个计数器，每次需要生成 ID 并且无法使用更好的方式时，它就会加一。

3. 处理字符串类型的 $function_to_add

if ( is_string( $function_to_add ) ) {
    return $function_to_add;
}

如果 $function_to_add 是一个字符串，那就简单了，直接返回这个字符串。这种情况通常是直接使用函数名，比如 'my_custom_function'。 这种情况下，函数名本身就充当了唯一 ID。

4. 将 $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;
}

这段代码有点意思。它把 $function_to_add 统一转换成数组。

• 如果 $function_to_add 是对象 (通常是闭包) : 它会被转换成 array($function_to_add, '')。 注意，第二个元素是空字符串。
• 否则: 它会被强制转换成数组。 这种情况通常是类的方法（array($this, 'method_name') 或者 array('MyClass', 'static_method')）或者普通的数组形式的回调函数。

这样做是为了方便后续的处理，统一了数据结构。

5. 处理对象方法调用

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 get_class( $function_to_add[0] ) . $function_to_add[1] . $filter_id_count;
    }
}

这段代码专门处理对象方法调用，也就是 $function_to_add 是一个数组，并且数组的第一个元素是一个对象。

• 如果 spl_object_hash 函数存在: 这是 PHP 提供的一个函数，用于生成对象的唯一哈希值。 它会返回一个字符串，可以保证在当前 PHP 进程中，同一个对象的哈希值始终相同。 这就是生成唯一 ID 的关键！将对象的哈希值和方法名（$function_to_add[1]）拼接起来，就得到了一个唯一的 ID。
• 如果 spl_object_hash 函数不存在: 这通常发生在较老的 PHP 版本中。 在这种情况下，就只能退而求其次了。 首先，使用 get_class() 函数获取对象的类名。 然后，将类名、方法名和静态计数器 $filter_id_count 拼接起来，作为 ID。 注意，每次进入这个分支，$filter_id_count 都会加一，以保证 ID 的唯一性。 这种方法的缺点是，如果两个不同的对象属于同一个类，它们的方法可能会生成相同的 ID，除非 $filter_id_count 能够区分它们。

6. 处理静态方法调用

elseif ( is_string( $function_to_add[0] ) ) {
    // Static Calling
    return $function_to_add[0] . '::' . $function_to_add[1];
}

这段代码处理静态方法调用，也就是 $function_to_add 是一个数组，并且数组的第一个元素是一个字符串（类名）。 在这种情况下，直接将类名、:: 和方法名拼接起来，作为 ID。 例如，'MyClass::static_method'。

总结：生成唯一 ID 的策略

咱们用表格来总结一下 _wp_filter_build_unique_id() 函数生成唯一 ID 的策略：

$function_to_add 类型	唯一 ID 生成方式	优点	缺点
字符串 (函数名)	直接返回函数名	简单高效	无法区分同名函数（虽然不推荐这么做）
对象 (闭包)	如果 spl_object_hash 存在，返回 spl_object_hash($function_to_add[0]) . $function_to_add[1]；否则，返回 get_class($function_to_add[0]) . $function_to_add[1] . $filter_id_count	spl_object_hash 方法保证在当前进程中唯一； get_class 方法在 spl_object_hash 不可用时提供备选方案	get_class 方法在多个相同类的对象时可能冲突； 旧版本PHP中没有spl_object_hash，可能导致唯一性降低
数组 (对象方法)	如果 spl_object_hash 存在，返回 spl_object_hash($function_to_add[0]) . $function_to_add[1]；否则，返回 get_class($function_to_add[0]) . $function_to_add[1] . $filter_id_count	spl_object_hash 方法保证在当前进程中唯一； get_class 方法在 spl_object_hash 不可用时提供备选方案	get_class 方法在多个相同类的对象时可能冲突； 旧版本PHP中没有spl_object_hash，可能导致唯一性降低
数组 (静态方法)	返回 $function_to_add[0] . '::' . $function_to_add[1]	简单高效	如果类名和方法名相同，则可能冲突（虽然不推荐）

例子：匿名函数/闭包的 ID 生成

假设我们有以下代码：

<?php
$anonymous_function = function() {
    echo 'Hello from anonymous function!';
};

add_filter( 'the_content', $anonymous_function );

//要移除这个匿名函数，我们需要它的唯一ID
$id = _wp_filter_build_unique_id( 'the_content', $anonymous_function, 10 ); // 假设优先级是 10
echo "The unique ID for the anonymous function is: " . $id . "n";

在这个例子中，$anonymous_function 是一个闭包（Closure），也就是匿名函数。 当调用 _wp_filter_build_unique_id() 函数时，$function_to_add 是一个对象。 如果你的 PHP 版本支持 spl_object_hash() 函数，那么 $id 将会是这个闭包对象的哈希值加上空字符串。 如果不支持，那么 $id 将会是 Closure 加上空字符串再加上一个计数器值。

例子：类方法的 ID 生成

<?php
class MyClass {
    public function my_method() {
        echo 'Hello from my method!';
    }
}

$my_object = new MyClass();
add_filter( 'the_content', array( $my_object, 'my_method' ) );

//要移除这个类方法，我们需要它的唯一ID
$id = _wp_filter_build_unique_id( 'the_content', array( $my_object, 'my_method' ), 10 ); // 假设优先级是 10
echo "The unique ID for the class method is: " . $id . "n";

在这个例子中，$function_to_add 是一个数组，包含了对象 $my_object 和方法名 'my_method'。 _wp_filter_build_unique_id() 函数会检测到 $function_to_add[0] 是一个对象，然后使用 spl_object_hash() (如果可用) 或 get_class() 来生成唯一 ID。

例子：静态方法的 ID 生成

<?php
class MyClass {
    public static function my_static_method() {
        echo 'Hello from my static method!';
    }
}

add_filter( 'the_content', array( 'MyClass', 'my_static_method' ) );

//要移除这个静态方法，我们需要它的唯一ID
$id = _wp_filter_build_unique_id( 'the_content', array( 'MyClass', 'my_static_method' ), 10 ); // 假设优先级是 10
echo "The unique ID for the static method is: " . $id . "n";

在这个例子中，$function_to_add 是一个数组，包含了类名 'MyClass' 和方法名 'my_static_method'。 _wp_filter_build_unique_id() 函数会检测到 $function_to_add[0] 是一个字符串，然后直接将类名和方法名拼接起来，生成唯一 ID，结果是 'MyClass::my_static_method'。

为什么要生成唯一 ID？

WordPress 的 remove_filter() 和 remove_action() 函数需要知道你要移除哪个钩子。 虽然你可以使用函数名来移除，但对于匿名函数和闭包来说，它们没有名字，所以必须使用唯一 ID 来标识。

总结

_wp_filter_build_unique_id() 函数是 WordPress 钩子系统中的一个重要组成部分。 它负责为匿名函数、闭包和类方法生成唯一的 ID，以便 WordPress 能够正确地管理和移除这些钩子。 虽然它的实现方式可能因为 PHP 版本的不同而有所差异，但其核心目标始终是确保 ID 的唯一性，从而保证钩子系统的正常运行。

希望今天的讲解对大家有所帮助！记住，理解这些底层机制能让你更好地掌握 WordPress，写出更高效、更可靠的代码。 下次有机会再和大家分享其他的 WordPress 源码分析。 晚安！