解析 WordPress `add_action()` 和 `add_filter()` 中的 “ 参数源码：其如何影响钩子函数的执行顺序。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位代码界的冒险家，晚上好！我是你们今晚的向导，今天我们要深入WordPress的魔法森林，探索add_action()和add_filter()这两个核心函数的奥秘，特别是那个看似简单的$priority参数，它如何影响钩子函数的执行顺序，决定着我们代码的命运。

准备好了吗？系好安全带，我们这就开始！

第一幕：钩子的世界观——什么是动作和过滤器？

在开始深入$priority之前，我们需要先搞清楚，WordPress的动作(Action)和过滤器(Filter)到底是什么鬼。

动作(Action)： 想象一下，WordPress在它的生命周期中，会在特定的时间点发出“信号”，比如“主题加载完毕！”、“文章发布了！”。动作就像是你在这些信号上挂了一个“监听器”，当信号发出时，你的监听器（也就是你定义的函数）就会被触发，执行一些自定义的操作。比如，你可以在主题加载完毕后，加载一些自定义的CSS或者JavaScript文件。
过滤器(Filter)： 过滤器则更像是一个“拦截器”。 WordPress在处理某些数据的时候，允许你“拦截”这些数据，对它们进行修改，然后再将修改后的数据传递下去。比如，你可以拦截文章的内容，添加一些广告，或者将某些敏感词替换掉。

简单来说：

特性	动作 (Action)	过滤器 (Filter)
目的	执行某些操作，通常没有返回值	修改数据，必须返回修改后的数据
使用场景	在特定事件发生时执行代码，例如发送邮件、记录日志	修改文章内容、标题、摘要等数据
返回值	无	必须返回经过修改后的数据，否则会影响 WordPress 的运行

第二幕：add_action()和add_filter()——如何注册钩子？

既然知道了动作和过滤器是什么，那么我们如何将自己的函数“挂”到这些钩子上呢？这就要用到add_action()和add_filter()这两个函数了。它们的用法非常相似，只是应用场景不同。

add_action( $tag, $function_to_add, $priority = 10, $accepted_args = 1 )
- $tag：动作的名称，也就是 WordPress 发出的“信号”的名字。比如 'wp_head' 表示在 <head> 标签内输出内容， 'publish_post' 表示文章发布时。
- $function_to_add：你要执行的函数的名字。注意，这里只是函数的名字，不是函数调用。
- $priority：重点来了！ 这是一个整数，用于指定函数执行的优先级。数字越小，优先级越高，越早执行。默认值是 10。
- $accepted_args：你的函数可以接收的参数的数量。 WordPress 会根据这个值，传递相应数量的参数给你的函数。
add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 )
- 参数的含义和 add_action() 几乎完全一样，除了 $tag 表示的是过滤器的名称。比如 'the_content' 表示文章的内容， 'the_title' 表示文章的标题。

第三幕：$priority的优先级奥义——谁先上，听我的！

现在，我们终于来到了$priority这个主角的舞台。毫不夸张地说，$priority决定了你的代码在钩子上的“地位”。如果你希望你的函数在其他函数之前执行，那么你需要设置一个比它们更小的$priority值。反之，如果你希望你的函数在其他函数之后执行，那么你需要设置一个更大的$priority值。

让我们用代码来感受一下：

// 定义一个函数，用于在文章标题后面添加 " - 重要文章"
function add_important_suffix( $title ) {
    return $title . ' - 重要文章';
}

// 定义一个函数，用于在文章标题后面添加 " - 特别推荐"
function add_recommended_suffix( $title ) {
    return $title . ' - 特别推荐';
}

// 将第一个函数挂到 `the_title` 过滤器上，优先级为 5 (较高)
add_filter( 'the_title', 'add_important_suffix', 5 );

// 将第二个函数挂到 `the_title` 过滤器上，优先级为 15 (较低)
add_filter( 'the_title', 'add_recommended_suffix', 15 );

// 假设文章标题是 "Hello World"
// 最终显示的标题将会是 "Hello World - 重要文章 - 特别推荐"

在这个例子中，add_important_suffix() 函数的优先级更高，所以它会先执行，在文章标题后面添加 " – 重要文章"。然后，add_recommended_suffix() 函数才会执行，在已经添加了 " – 重要文章" 的标题后面，再添加 " – 特别推荐"。

如果我们将两个函数的优先级调换一下：

// 将第一个函数挂到 `the_title` 过滤器上，优先级为 15 (较低)
add_filter( 'the_title', 'add_important_suffix', 15 );

// 将第二个函数挂到 `the_title` 过滤器上，优先级为 5 (较高)
add_filter( 'the_title', 'add_recommended_suffix', 5 );

// 假设文章标题是 "Hello World"
// 最终显示的标题将会是 "Hello World - 特别推荐 - 重要文章"

最终显示的标题就会变成 "Hello World – 特别推荐 – 重要文章"。

表格总结： $priority 的威力

`$priority` 值	执行顺序	影响
越小	越早	可以在其他函数之前修改数据，影响后续函数的行为
越大	越晚	可以看到其他函数修改后的数据，并基于这些修改进行进一步的操作
相同	按照注册顺序	如果多个函数的 `$priority` 值相同，那么它们会按照注册的顺序执行。这通常是不确定的，应尽量避免

第四幕：源码剖析——WordPress 如何管理钩子函数？

为了更深入地理解$priority的作用，我们需要简单地看一下WordPress是如何管理这些钩子函数的。

WordPress 使用一个全局变量 $wp_filter (或者 $wp_actions, $wp_filters，取决于 WordPress 版本) 来存储所有的动作和过滤器。 $wp_filter 是一个多维数组，其结构大致如下：

$wp_filter = array(
    'hook_name' => array( // 钩子的名称
        'priority' => array( // 优先级
            'function_name' => array( // 函数的名称
                'accepted_args' => ..., // 接收的参数数量
                'function' => 'callable', // 可调用的函数 (函数名或者匿名函数)
            ),
            ... // 其他函数
        ),
        ... // 其他优先级
    ),
    ... // 其他钩子
);

当我们使用 add_action() 或 add_filter() 注册一个函数时，WordPress 会将这个函数的信息存储到 $wp_filter 数组中，并按照 $priority 值进行排序。

当 WordPress 触发一个动作或过滤器时，它会从 $wp_filter 数组中取出对应钩子的所有函数，并按照 $priority 值从小到大依次执行这些函数。

代码片段：模拟 WordPress 的钩子执行过程

为了更直观地理解，我们可以简单地模拟一下 WordPress 的钩子执行过程：

// 模拟 $wp_filter 数组
$wp_filter = array(
    'my_hook' => array(
        10 => array(
            'function_a' => array(
                'accepted_args' => 1,
                'function' => 'function_a',
            ),
            'function_b' => array(
                'accepted_args' => 1,
                'function' => 'function_b',
            ),
        ),
        5 => array(
            'function_c' => array(
                'accepted_args' => 1,
                'function' => 'function_c',
            ),
        ),
        15 => array(
            'function_d' => array(
                'accepted_args' => 1,
                'function' => 'function_d',
            ),
        ),
    ),
);

// 模拟函数
function function_a( $value ) {
    echo "Function A: " . $value . "<br>";
    return $value . " - A";
}

function function_b( $value ) {
    echo "Function B: " . $value . "<br>";
    return $value . " - B";
}

function function_c( $value ) {
    echo "Function C: " . $value . "<br>";
    return $value . " - C";
}

function function_d( $value ) {
    echo "Function D: " . $value . "<br>";
    return $value . " - D";
}

// 模拟执行钩子
function do_action( $hook_name, $value ) {
    global $wp_filter;

    if ( ! isset( $wp_filter[ $hook_name ] ) ) {
        return $value;
    }

    // 获取所有优先级
    $priorities = array_keys( $wp_filter[ $hook_name ] );

    // 按照优先级排序
    sort( $priorities );

    // 循环执行所有函数
    foreach ( $priorities as $priority ) {
        foreach ( $wp_filter[ $hook_name ][ $priority ] as $function_name => $function_data ) {
            $function = $function_data['function'];
            $value = call_user_func( $function, $value );
        }
    }

    return $value;
}

// 执行 "my_hook" 钩子
$initial_value = "Hello World";
$final_value = do_action( 'my_hook', $initial_value );

echo "Final Value: " . $final_value;

这段代码模拟了 WordPress 如何根据 $priority 值来排序和执行钩子函数。你可以运行这段代码，看看输出结果，加深对 $priority 的理解。

第五幕：$priority的实战技巧——避免踩坑，优雅编码

了解了 $priority 的原理之后，我们还需要掌握一些实战技巧，避免踩坑，写出更优雅的代码。

谨慎选择 $priority 值：
- 不要随意设置 $priority 值，要根据你的代码的实际需求来选择。
- 如果你的代码需要在其他代码之前执行，那么选择一个较小的 $priority 值。
- 如果你的代码需要在其他代码之后执行，那么选择一个较大的 $priority 值。
- 尽量避免使用与其他插件或主题相同的 $priority 值，以免产生冲突。

使用常量代替数字：

为了提高代码的可读性和可维护性，可以使用常量来代替数字作为 $priority 值。

define( 'MY_PLUGIN_EARLY_PRIORITY', 5 );
define( 'MY_PLUGIN_DEFAULT_PRIORITY', 10 );
define( 'MY_PLUGIN_LATE_PRIORITY', 15 );

add_filter( 'the_title', 'my_plugin_modify_title', MY_PLUGIN_EARLY_PRIORITY );

了解 WordPress 的默认 $priority 值：
- WordPress 自身的一些函数也使用了 $priority 参数，了解这些默认值可以帮助你更好地控制代码的执行顺序。
- 例如，wp_head 钩子有很多 WordPress 核心函数挂载，了解它们的优先级，可以让你在合适的位置插入自己的代码。
使用调试工具：
- 如果你的代码没有按照预期的顺序执行，可以使用调试工具来查看 $wp_filter 数组，了解所有注册到该钩子的函数及其 $priority 值。
- 可以使用 var_dump( $GLOBALS['wp_filter']['your_hook_name'] ); 来查看特定钩子的所有函数。
命名约定：
- 在函数名中包含优先级信息，可以提高代码的可读性。例如 my_plugin_modify_title_early() 或 my_plugin_modify_title_late()。

第六幕：常见问题解答——解决你的疑惑

如果多个函数的 $priority 值相同，会发生什么？
- 如果多个函数的 $priority 值相同，那么它们会按照注册的顺序执行。但是，这种行为是不确定的，应尽量避免。因为注册顺序可能受到插件加载顺序、主题加载顺序等因素的影响。
$accepted_args 参数有什么用？
- $accepted_args 参数用于指定你的函数可以接收的参数的数量。 WordPress 会根据这个值，传递相应数量的参数给你的函数。
- 如果你的函数不需要接收任何参数，那么可以将 $accepted_args 设置为 0。
- 如果你的函数需要接收 WordPress 传递的所有参数，那么可以将 $accepted_args 设置为一个足够大的值 (例如 99)。
如何移除一个已经注册的钩子函数？
- 可以使用 remove_action() 和 remove_filter() 函数来移除一个已经注册的钩子函数。
```
remove_action( 'wp_head', 'my_plugin_add_meta_tags', 10 );
remove_filter( 'the_content', 'my_plugin_modify_content', 15 );
```
- 注意，你需要提供与 add_action() 或 add_filter() 函数相同的参数 (包括 $tag, $function_to_add, 和 $priority)。

第七幕：总结——掌握 $priority，掌控你的代码

恭喜各位冒险家，我们已经成功地走出了WordPress的魔法森林！通过今天的学习，我们深入了解了add_action()和add_filter()函数中$priority参数的作用，以及它如何影响钩子函数的执行顺序。

掌握了$priority，你就掌握了在WordPress的钩子世界中控制代码执行顺序的关键。你可以根据自己的需求，灵活地调整 $priority 值，让你的代码在正确的时间执行，与其他插件和主题和谐共处，创造出更强大的WordPress应用。

记住，编码就像魔法，而$priority就是你手中的魔杖，挥舞它，创造出属于你的魔法！

感谢大家的聆听，祝大家编码愉快！

发表回复 取消回复

发表回复取消回复