探究 WordPress `_wp_filter_build_unique_id()` 函数源码：如何为匿名函数和闭包生成唯一的 ID。

早上好，各位代码探险家！今天我们要扒开WordPress的一段神秘代码，看看_wp_filter_build_unique_id()这个函数是如何给那些“来无影去无踪”的匿名函数和闭包生成独一无二的身份证的。准备好了吗？让我们开始这场代码解剖之旅！

引言：函数的身份证难题

在WordPress的世界里，钩子（Hooks）机制允许开发者在代码执行的关键点插入自定义函数，增强或修改WordPress的行为。这些自定义函数可能是普通函数，也可能是匿名函数或闭包。

想象一下，你向一个事件（比如the_content这个钩子）注册了多个函数，WordPress需要知道哪些函数已经被注册了，以及哪个函数需要被移除。这就需要给每一个函数分配一个唯一的标识符（ID）。

对于具名函数，这很简单，直接用函数名就行了。但问题来了，匿名函数和闭包没有名字！它们就像幽灵一样，飘忽不定。那么，WordPress是如何给这些幽灵函数分配身份证的呢？这就是_wp_filter_build_unique_id()函数要解决的问题。

_wp_filter_build_unique_id() 函数概览

这个函数位于 wp-includes/functions.php 文件中。它的作用是根据给定的函数和优先级，生成一个唯一的ID。这个ID用于在全局 $wp_filter 数组中存储和检索钩子函数。

/**
 * Build Unique ID from Function name and priority.
 *
 * @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 filter callback function.
 * @param int $priority The priority at which to hook the function. Default 10.
 * @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 spl_object_hash( $function_to_add[0] ) . $function_to_add[1];
        } else {
            $obj_idx = get_class( $function_to_add[0] ) . $function_to_add[1];
            if ( isset( $function_to_add[0]->wp_filter_id ) ) {
                $obj_idx .= $function_to_add[0]->wp_filter_id;
            }
            return $obj_idx;
        }
    } elseif ( is_string( $function_to_add[0] ) ) {
        // Static Calling
        return $function_to_add[0] . '::' . $function_to_add[1];
    }
    ++$filter_id_count;
    return md5( $tag . serialize( $function_to_add ) . $priority ) . '_' . $filter_id_count;
}

代码分解与注释

现在，让我们逐行剖析这段代码，看看它是如何工作的。

1. 静态变量 $filter_id_count

   static $filter_id_count = 0;

   这是一个静态变量，用于记录已生成的ID数量。每次需要生成新的ID时，它都会递增。这个变量的作用是确保即使在极其罕见的情况下，MD5哈希发生碰撞，ID仍然是唯一的。

2. 处理字符串类型的函数名

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

   如果 $function_to_add 是一个字符串，那么它代表一个普通的函数名。在这种情况下，直接返回函数名作为ID。这是最简单的情况。

3. 处理闭包（Closures）

   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;
   }

   在PHP中，闭包被实现为对象。这段代码将闭包对象转换为一个数组，以便后续处理。注意，这里将闭包对象和空字符串组成了一个数组。这是为了统一处理不同类型的回调函数。如果不是对象，则强制转换为数组，确保后续处理的统一性。

4. 处理对象方法调用

   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 {
           $obj_idx = get_class( $function_to_add[0] ) . $function_to_add[1];
           if ( isset( $function_to_add[0]->wp_filter_id ) ) {
               $obj_idx .= $function_to_add[0]->wp_filter_id;
           }
           return $obj_idx;
       }
   }

   这段代码处理的是通过对象调用方法的情况，例如 [$my_object, 'my_method']。

   • spl_object_hash() 函数： 如果PHP安装了 SPL 扩展，并且 spl_object_hash() 函数可用，那么就使用这个函数生成对象的唯一哈希值。这个哈希值是基于对象的内存地址生成的，因此保证了唯一性。然后，将这个哈希值与方法名（$function_to_add[1]）连接起来，作为ID。
   • 备选方案： 如果 spl_object_hash() 函数不可用，那么就使用 get_class() 函数获取对象的类名，然后与方法名连接起来。如果对象有一个名为 wp_filter_id 的属性，那么也将这个属性值添加到ID中。 如果没有 wp_filter_id 属性，重复添加同一个方法，会无法区分开，导致无法正确删除。

5. 处理静态方法调用

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

   这段代码处理的是静态方法调用，例如 ['MyClass', 'my_static_method']。它直接将类名和方法名用 :: 连接起来，作为ID。

6. 处理匿名函数和其他情况

   ++$filter_id_count;
   return md5( $tag . serialize( $function_to_add ) . $priority ) . '_' . $filter_id_count;

   如果以上所有情况都不匹配，那么就认为这是一个匿名函数或其他无法直接生成唯一ID的情况。

   • 递增计数器： 首先，递增静态变量 $filter_id_count。
   • 生成MD5哈希： 然后，使用 md5() 函数生成一个哈希值。哈希值的输入包括：
     • $tag：钩子的名称。
     • serialize($function_to_add)：将函数序列化成字符串。这包括了函数的所有信息，例如闭包中使用的变量。
     • $priority：钩子的优先级。
   • 拼接ID： 最后，将MD5哈希值与计数器值用 _ 连接起来，作为ID。

为什么使用MD5哈希？

使用MD5哈希的主要目的是为了生成一个相对较短且唯一的ID。虽然MD5哈希有碰撞的风险，但在实际应用中，由于输入的数据包含了钩子名称、函数序列化后的字符串和优先级，因此碰撞的概率非常低。

代码示例：匿名函数和闭包的身份证

让我们通过一些代码示例，看看 _wp_filter_build_unique_id() 函数是如何给匿名函数和闭包生成身份证的。

示例1：简单的匿名函数

add_filter( 'the_content', function( $content ) {
    return $content . '<div>Hello, world!</div>';
}, 10 );

在这个例子中，我们向 the_content 钩子注册了一个匿名函数。_wp_filter_build_unique_id() 函数会这样生成ID：

1. $tag 是 'the_content'。
2. $function_to_add 是一个匿名函数（闭包对象）。
3. $priority 是 10。

函数会先将闭包对象转换成数组 [$closure_object, '']，然后由于不是对象方法和静态方法，会走到最后的MD5哈希生成逻辑。

生成的ID类似这样："e4d909c290d0fb1ca068ffaddf22cbd0_1"。 其中e4d909c290d0fb1ca068ffaddf22cbd0是md5哈希，1 是$filter_id_count。

示例2：使用外部变量的闭包

$message = 'Greetings from the outside!';
add_filter( 'the_content', function( $content ) use ( $message ) {
    return $content . '<div>' . $message . '</div>';
}, 10 );

这个例子中，闭包使用了外部变量 $message。这会影响 serialize() 函数的输出，从而生成不同的MD5哈希值。

1. $tag 是 'the_content'。
2. $function_to_add 是一个闭包对象，它使用了外部变量 $message。
3. $priority 是 10。

由于闭包使用了外部变量，serialize() 函数会包含这个变量的信息。因此，生成的MD5哈希值会与前面的例子不同。

生成的ID类似这样："a94a8fe5ccb19ba61c4c0873d391e987_2"。

示例3：对象方法

class MyClass {
    public function my_method( $content ) {
        return $content . '<div>From MyClass!</div>';
    }
}

$my_object = new MyClass();
add_filter( 'the_content', [$my_object, 'my_method'], 10 );

在这个例子中，我们向 the_content 钩子注册了一个对象方法。

1. $tag 是 'the_content'。
2. $function_to_add 是一个数组 [$my_object, 'my_method']。
3. $priority 是 10。

由于$function_to_add[0] 是一个对象，会执行对象方法调用分支的代码。
如果 spl_object_hash() 可用，生成的ID会类似这样： "000000007e545f7800000000009021a7my_method"。
否则，生成的ID会类似这样： "MyClassmy_method"。 如果$my_object 有 wp_filter_id 属性， 还会追加到字符串后面。

示例4：静态方法

class MyStaticClass {
    public static function my_static_method( $content ) {
        return $content . '<div>From MyStaticClass!</div>';
    }
}

add_filter( 'the_content', ['MyStaticClass', 'my_static_method'], 10 );

在这个例子中，我们向 the_content 钩子注册了一个静态方法。

1. $tag 是 'the_content'。
2. $function_to_add 是一个数组 ['MyStaticClass', 'my_static_method']。
3. $priority 是 10。

由于$function_to_add[0] 是一个字符串，会执行静态方法调用分支的代码。

生成的ID会是 "MyStaticClass::my_static_method"。

总结：_wp_filter_build_unique_id() 的智慧

_wp_filter_build_unique_id() 函数的设计非常巧妙，它考虑了各种情况，包括普通函数、匿名函数、闭包、对象方法和静态方法。它使用不同的策略来生成唯一的ID，以确保WordPress能够正确地管理钩子函数。

下面是一个表格，总结了不同情况下ID的生成方式：

函数类型	ID生成方式
普通函数	直接使用函数名。
匿名函数/闭包	1. 递增静态变量 $filter_id_count。
	2. 使用 md5() 函数生成一个哈希值，输入包括钩子名称、函数序列化后的字符串和优先级。
	3. 将MD5哈希值与计数器值用 _ 连接起来，作为ID。
对象方法	1. 如果 spl_object_hash() 函数可用，则使用它生成对象的唯一哈希值，并与方法名连接起来。
	2. 否则，使用 get_class() 函数获取对象的类名，然后与方法名连接起来。如果对象有一个名为 wp_filter_id 的属性，那么也将这个属性值添加到ID中。
静态方法	将类名和方法名用 :: 连接起来。

性能考量

serialize() 函数可能会比较耗时，尤其是在处理包含大量数据的闭包时。因此，在性能敏感的场景中，应该尽量避免使用复杂的闭包，或者考虑使用具名函数来代替。

总结

通过这次代码解剖，我们深入了解了 _wp_filter_build_unique_id() 函数的工作原理，以及它是如何为WordPress中的匿名函数和闭包生成唯一的ID的。希望这次探险对你有所帮助！记住，代码的世界充满了惊喜，只要你敢于探索，就能发现其中的奥秘。

各位，下次再见！希望你们都能写出更优雅、更高效的代码！