阐述 WordPress 如何通过 `add_action` 和 `do_action` 实现钩子机制，并分析其底层的数据结构和执行流程。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位朋友，晚上好！我是老码农，今天咱们来聊聊 WordPress 里那些神出鬼没的“钩子”，也就是 add_action 和 do_action。说它们神出鬼没，是因为你可能天天用，但未必真正理解它们背后的原理。别担心，今晚我就带你把这层神秘的面纱彻底揭开，保证你以后再看到这些代码，心里门儿清！

一、什么是钩子？为什么需要钩子？

首先，咱们得明白什么是钩子。你可以把 WordPress 想象成一个巨大的流水线，它按照既定的流程一步一步地处理请求，生成页面。但是，有时候我们想在某个特定的环节“插一脚”，做一些自定义的操作，比如在文章发布后发送邮件通知，或者在评论提交前进行内容审查。

如果直接修改 WordPress 的核心代码，那简直就是一场灾难！一是升级的时候会被覆盖，二是万一改错了，整个网站就崩了。所以，聪明的设计师们就发明了“钩子”这种机制。

钩子就像流水线上的预留接口，允许我们把自己的代码“挂”上去，在特定的时刻自动执行。这样，我们既能实现自定义功能，又不会破坏 WordPress 的核心代码。

二、add_action：挂钩子的正确姿势

add_action 函数就是用来“挂钩子”的。它的作用是告诉 WordPress，当某个特定的事件发生时，执行我指定的函数。

add_action( string $tag, callable $function_to_add, int $priority = 10, int $accepted_args = 1 )

$tag：钩子的名称，也就是你想在哪儿“插一脚”。WordPress 内部预定义了很多钩子，比如 wp_head（在 <head> 标签里输出内容）、the_content（文章内容）、comment_post（评论提交后）等等。你也可以自定义钩子。
$function_to_add：你要执行的函数名，可以是普通的函数，也可以是类的方法。
$priority：优先级，数字越小优先级越高。如果多个函数挂在同一个钩子上，WordPress 会按照优先级从高到低依次执行。默认值是 10。
$accepted_args：传递给函数的参数个数。WordPress 会根据这个参数，把相应数量的参数传递给你的函数。默认值是 1。

举个例子，假设我们想在文章发布后，发送一封邮件给管理员，就可以这样写：

function send_notification_email( $post_id ) {
  $post = get_post( $post_id );
  $subject = '文章发布通知：' . $post->post_title;
  $message = '有一篇新文章发布啦！快去看看吧：' . get_permalink( $post_id );
  wp_mail( get_option( 'admin_email' ), $subject, $message );
}

add_action( 'publish_post', 'send_notification_email', 10, 1 );

这段代码的意思是：当 publish_post 事件发生时（也就是文章发布时），执行 send_notification_email 函数，并且把文章 ID 作为参数传递给它。

三、do_action：触发钩子的信号枪

do_action 函数的作用是“触发”一个钩子。它就像一把信号枪，当它发射时，所有挂在这个钩子上的函数都会被执行。

do_action( string $tag, mixed ...$arg )

$tag：钩子的名称，必须和 add_action 里使用的名称一致。
...$arg：要传递给函数的参数，可以传递任意数量的参数。

WordPress 核心代码里有很多 do_action 函数，它们分布在不同的地方，负责触发不同的事件。比如，在发布文章的时候，WordPress 会调用 do_action( 'publish_post', $post->ID )，告诉所有监听 publish_post 钩子的函数，文章已经发布了，并且把文章 ID 作为参数传递给它们。

四、底层数据结构：钩子的幕后推手

add_action 和 do_action 之所以能够工作，离不开 WordPress 内部的一个全局变量：$wp_filter。

$wp_filter 是一个多维数组，它的结构大概是这样的：

$wp_filter = array(
  'hook_name' => array(
    'priority' => array(
      'callback_identifier' => array(
        'function' => 'callback_function',
        'accepted_args' => 'number_of_arguments'
      )
    )
  )
);

hook_name：钩子的名称，比如 wp_head、the_content 等等。
priority：优先级，数字越小优先级越高。
callback_identifier：回调函数的唯一标识符，通常是函数名或者类的方法名。
function：回调函数本身。
accepted_args：回调函数可以接受的参数个数。

当我们调用 add_action 函数时，WordPress 实际上是在修改 $wp_filter 数组，把我们的回调函数添加到相应的钩子和优先级下面。

当我们调用 do_action 函数时，WordPress 会遍历 $wp_filter 数组，找到所有挂在这个钩子上的函数，然后按照优先级依次执行它们。

为了更直观地理解 $wp_filter 的结构，咱们来看一个例子：

add_action( 'wp_head', 'my_header_function', 10 );
add_action( 'wp_head', 'another_header_function', 5 );
add_action( 'the_content', 'my_content_filter', 10, 1 );

执行完这段代码后，$wp_filter 数组可能会是这样的（简化版）：

$wp_filter = array(
  'wp_head' => array(
    5 => array(
      'another_header_function' => array(
        'function' => 'another_header_function',
        'accepted_args' => 1
      )
    ),
    10 => array(
      'my_header_function' => array(
        'function' => 'my_header_function',
        'accepted_args' => 1
      )
    )
  ),
  'the_content' => array(
    10 => array(
      'my_content_filter' => array(
        'function' => 'my_content_filter',
        'accepted_args' => 1
      )
    )
  )
);

可以看到，$wp_filter 数组清晰地记录了每个钩子上有哪些函数，它们的优先级是多少，以及它们可以接受的参数个数。

五、执行流程：钩子的生命周期

现在，我们来梳理一下钩子的执行流程：

add_action 注册： 当我们调用 add_action 函数时，WordPress 会把回调函数的信息添加到 $wp_filter 数组中。
do_action 触发： 当 WordPress 执行到 do_action 函数时，它会从 $wp_filter 数组中找到所有挂在这个钩子上的函数。
回调函数执行： WordPress 会按照优先级从高到低的顺序，依次执行这些回调函数，并且把 do_action 传递的参数传递给它们。
返回结果： 回调函数可以修改传递给它们的参数，并且把修改后的结果返回给 WordPress。

可以用一个表格来概括：

步骤	函数	作用	数据结构变化
1. 注册	`add_action`	将回调函数注册到钩子上	修改 `$wp_filter` 数组，添加回调函数信息
2. 触发	`do_action`	触发钩子，执行所有注册的回调函数	遍历 `$wp_filter` 数组，查找回调函数信息
3. 执行	回调函数	执行自定义代码，可以修改参数	无
4. 返回结果	回调函数	返回修改后的参数（如果有的话）	无

六、Action 和 Filter：钩子的两个变种

WordPress 有两种类型的钩子：Action 和 Filter。

Action： 用于执行一些操作，比如发送邮件、记录日志等等。Action 函数通常不需要返回任何值。
Filter： 用于修改数据，比如过滤文章内容、修改标题等等。Filter 函数必须返回修改后的数据。

虽然 Action 和 Filter 的作用不同，但它们的底层实现机制是完全一样的，都是通过 $wp_filter 数组来管理回调函数。

为了区分 Action 和 Filter，WordPress 提供了两个不同的函数：

add_action 和 do_action 用于处理 Action。
add_filter 和 apply_filters 用于处理 Filter。

实际上，add_action 和 add_filter 只是对 add_filter 函数的封装，它们最终都会调用 add_filter 函数来修改 $wp_filter 数组。

do_action 和 apply_filters 的区别在于，apply_filters 函数会返回经过所有 Filter 函数处理后的数据，而 do_action 函数不会返回任何值。

七、实例分析：修改文章标题

为了更好地理解 Filter 的用法，咱们来看一个例子：修改文章标题。

function modify_post_title( $title ) {
  return '【置顶】' . $title;
}

add_filter( 'the_title', 'modify_post_title' );

这段代码的意思是：当 WordPress 要显示文章标题时，先执行 modify_post_title 函数，把标题加上 【置顶】 前缀，然后再显示。

the_title 是一个 Filter 钩子，它允许我们修改文章标题。modify_post_title 函数接收一个参数 $title，也就是原始的文章标题，然后返回修改后的标题。

WordPress 会把 apply_filters( 'the_title', $title ) 的返回值作为最终的文章标题显示出来。

八、自定义钩子：打造自己的扩展点

除了使用 WordPress 预定义的钩子之外，我们还可以自定义钩子，为自己的插件或主题提供扩展点。

自定义钩子非常简单，只需要使用 do_action 或 apply_filters 函数即可。

例如，假设我们想在插件的设置页面显示一些自定义内容，可以这样做：

// 在设置页面显示自定义内容
function display_custom_settings() {
  echo '<p>这里是自定义设置内容。</p>';
  do_action( 'my_plugin_settings' ); // 触发自定义钩子
}

// 在自定义钩子上挂载函数
function add_custom_settings() {
  echo '<p>这里是另一个自定义设置内容。</p>';
}

add_action( 'my_plugin_settings', 'add_custom_settings' );

在这个例子中，我们在 display_custom_settings 函数中调用了 do_action( 'my_plugin_settings' )，触发了一个名为 my_plugin_settings 的自定义钩子。

然后，我们使用 add_action 函数，把 add_custom_settings 函数挂载到 my_plugin_settings 钩子上。

这样，当 display_custom_settings 函数执行时，add_custom_settings 函数也会被执行，从而在设置页面显示自定义内容。

九、注意事项：钩子的最佳实践

在使用钩子时，有一些注意事项需要牢记：

钩子名称要唯一： 避免使用和其他插件或主题冲突的钩子名称。
优先级要合理： 根据实际情况设置优先级，确保回调函数按照正确的顺序执行。
参数个数要匹配： 确保回调函数可以接受 do_action 或 apply_filters 传递的参数。
避免过度使用： 不要滥用钩子，只在必要的时候才使用，避免影响性能。
及时移除钩子： 如果不再需要某个钩子，可以使用 remove_action 或 remove_filter 函数把它移除，避免内存泄漏。

十、总结：钩子的力量

钩子机制是 WordPress 扩展性的核心。它允许开发者在不修改 WordPress 核心代码的情况下，自定义功能，扩展 WordPress 的能力。

通过 add_action 和 do_action（以及 add_filter 和 apply_filters），我们可以轻松地挂载和触发钩子，实现各种各样的自定义功能。

理解钩子的底层数据结构和执行流程，可以帮助我们更好地使用钩子，编写更高效、更健壮的 WordPress 插件和主题。

好了，今天的讲座就到这里。希望通过今天的讲解，你已经对 WordPress 的钩子机制有了更深入的理解。记住，钩子就像乐高积木，可以让我们自由地组合，创造出无限可能！谢谢大家！

发表回复 取消回复

发表回复取消回复