探究 WordPress `did_action()` 函数源码：如何追踪一个钩子被执行了多少次。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

观众朋友们，晚上好！我是你们的老朋友，bug 终结者，今天咱们聊聊 WordPress 的一个很有意思的函数：did_action()，以及如何用它来追踪一个钩子被执行了多少次。这玩意儿就像侦探破案一样，看看哪个钩子最活跃，背后又隐藏着什么秘密。

一、did_action()：你是谁？从哪里来？要到哪里去？

首先，咱们得搞清楚 did_action() 是个什么东西。简单来说，did_action() 是 WordPress 提供的一个函数，用于判断某个 action hook (动作钩子) 是否已经被触发过。更厉害的是，它还能告诉你这个钩子已经被触发了多少次。

它的原型是这样的：

/**
 * Retrieve the number of times an action is fired.
 *
 * @since 2.1.0
 *
 * @param string $action Action hook to check.
 * @return int Number of times action has fired.
 */
function did_action( $action ) {
    global $wp_actions;

    if ( ! isset( $wp_actions[$action] ) ) {
        return false;
    }

    return $wp_actions[$action];
}

看看源码，是不是感觉也没那么神秘？

$action: 这是你要检查的 action hook 的名字，比如 'wp_head'，'save_post' 等等。
global $wp_actions: $wp_actions 是一个全局变量，它是一个数组，用来记录每个 action hook 被触发的次数。
isset( $wp_actions[$action] ): 检查 $wp_actions 数组中是否存在以 $action 为键的元素。如果不存在，说明这个 action 还没被触发过。
return $wp_actions[$action]: 如果存在，就返回 $wp_actions[$action] 的值，也就是这个 action 被触发的次数。

简单概括一下：did_action() 函数就是去 $wp_actions 这个全局数组里查户口，看看你要查的 action hook 的户口有没有登记，登记了几次。

二、$wp_actions：幕后大佬现身

既然 did_action() 的工作原理依赖于 $wp_actions，那么我们就来扒一扒 $wp_actions 的底裤，看看它到底是怎么工作的。

$wp_actions 数组在 wp-includes/plugin.php 文件中定义和使用。它主要由 do_action() 函数来维护。每次 do_action() 被调用来触发一个 action hook 时，$wp_actions 数组中对应的计数器就会加 1。

让我们看看 do_action() 函数的核心部分：

/**
 * Execute functions hooked on a specific action hook.
 *
 * @since 1.5.0
 *
 * @param string $hook_name The name of the action to be executed.
 * @param mixed  ...$arg Optional. Additional arguments which are passed on to the
 *                       functions hooked to the action. Default empty.
 */
function do_action( $hook_name, ...$arg ) {
    global $wp_actions, $wp_filter;

    if ( ! isset( $wp_actions[ $hook_name ] ) ) {
        $wp_actions[ $hook_name ] = 1;
    } else {
        ++$wp_actions[ $hook_name ];
    }

    // ... (省略了其他代码，比如执行钩子函数的部分)
}

这段代码逻辑非常清晰：

global $wp_actions: 声明使用全局变量 $wp_actions。
if ( ! isset( $wp_actions[ $hook_name ] ) ): 判断 $wp_actions 数组中是否已经存在以 $hook_name 为键的元素。如果不存在，说明这个 action 第一次被触发。
$wp_actions[ $hook_name ] = 1: 如果第一次触发，就将 $wp_actions[ $hook_name ] 的值设置为 1。
else { ++$wp_actions[ $hook_name ]; }: 如果已经存在，说明这个 action 之前已经被触发过，那么就将 $wp_actions[ $hook_name ] 的值加 1。

所以，do_action() 不仅负责触发 action hook，还负责更新 $wp_actions 数组，记录每个 action hook 被触发的次数。 did_action() 只是负责查询 $wp_actions 数组。

三、实战演练：追踪钩子的足迹

理论讲完了，现在咱们来点实际的。假设你想知道 wp_head 这个 action hook 在页面加载过程中被触发了多少次，你可以这样做：

add_action( 'wp_head', 'track_wp_head_count' );

function track_wp_head_count() {
    $count = did_action( 'wp_head' );
    echo '<script>console.log("wp_head has been fired ' . $count . ' times.");</script>';
}

这段代码做了什么？

add_action( 'wp_head', 'track_wp_head_count' ): 将 track_wp_head_count 函数挂载到 wp_head action hook 上。
function track_wp_head_count() { ... }: 定义 track_wp_head_count 函数，这个函数会在 wp_head 被触发时执行。
$count = did_action( 'wp_head' ): 在 track_wp_head_count 函数中，调用 did_action( 'wp_head' ) 获取 wp_head 被触发的次数。
echo '<script>console.log("wp_head has been fired ' . $count . ' times.");</script>': 将统计结果输出到浏览器的控制台。

把这段代码放到你的主题的 functions.php 文件中，或者放到一个自定义插件中，然后刷新你的网站页面，打开浏览器的控制台，你就能看到 wp_head action hook 被触发的次数了。

四、更高级的用法：条件判断与性能优化

did_action() 不仅仅可以用来统计次数，还可以用来进行条件判断，优化代码性能。

例如，假设你的主题或插件需要在 wp_footer action hook 中执行一些耗时的操作，但你只想在 wp_footer 第一次被触发时执行这些操作，你可以这样做：

add_action( 'wp_footer', 'expensive_operation' );

function expensive_operation() {
    if ( did_action( 'wp_footer' ) === 1 ) {
        // 只在 wp_footer 第一次被触发时执行
        // 这里放你的耗时操作
        echo '<script>console.log("Expensive operation executed only once!");</script>';
    }
}

这样，expensive_operation 函数中的代码只会执行一次，避免了重复执行带来的性能问题。

五、did_action() 的局限性：并非万能

虽然 did_action() 很实用，但它也有一些局限性。

只能追踪 action hook: did_action() 只能追踪 action hook，不能追踪 filter hook (过滤器钩子)。如果你想知道某个 filter hook 被应用了多少次，你需要使用其他方法。
依赖全局变量 $wp_actions: did_action() 依赖于全局变量 $wp_actions，如果 $wp_actions 被意外修改或清空，did_action() 的结果可能会不准确。
只能在 action hook 触发后使用: did_action() 只能在 action hook 触发后使用，不能在 action hook 触发前使用。因为在 action hook 触发前，$wp_actions 数组中还没有对应的记录。

六、常见问题与解决方案

did_action() 返回 false 或 0: 这通常意味着你检查的 action hook 还没有被触发。检查你的代码，确保这个 action hook 确实会被触发，并且你的代码在 action hook 触发后执行。
did_action() 返回的值与预期不符: 这可能是因为 $wp_actions 数组被意外修改或清空。检查你的代码，看看是否有其他地方修改了 $wp_actions 数组。也有可能是你在错误的时刻调用了 did_action()，导致它获取的值不准确。

如何追踪 filter hook 被应用的次数？: did_action() 无法追踪 filter hook。你可以自己维护一个计数器，在 filter hook 的回调函数中将计数器加 1。

$my_filter_count = 0;

add_filter( 'the_content', 'track_the_content_filter' );

function track_the_content_filter( $content ) {
    global $my_filter_count;
    $my_filter_count++;
    // 在这里处理内容
    return $content;
}

// 获取 the_content filter 被应用的次数
function get_the_content_filter_count() {
    global $my_filter_count;
    return $my_filter_count;
}

七、总结：did_action() 的价值与应用场景

特性	描述
功能	统计 action hook 被触发的次数
依赖	全局变量 `$wp_actions`
适用场景	调试代码，优化性能，条件判断
局限性	只能追踪 action hook，依赖全局变量 `$wp_actions`，只能在 action hook 触发后使用
替代方案	对于 filter hook，需要自己维护计数器

did_action() 是一个简单但非常有用的函数，它可以帮助你更好地理解 WordPress 的运行机制，调试代码，优化性能。虽然它有一些局限性，但只要你了解它的工作原理和适用场景，就能充分发挥它的价值。

八、代码示例：一个完整的插件示例

为了让你更深入地理解 did_action() 的用法，这里提供一个完整的 WordPress 插件示例，这个插件会记录 wp_head 和 wp_footer 这两个 action hook 被触发的次数，并在后台管理界面显示出来。

<?php
/**
 * Plugin Name: Action Hook Tracker
 * Description: Tracks the number of times action hooks are fired.
 * Version: 1.0
 * Author: Your Name
 */

// 记录 wp_head 和 wp_footer 被触发的次数
add_action( 'wp_head', 'track_wp_head' );
add_action( 'wp_footer', 'track_wp_footer' );

function track_wp_head() {
    // 什么也不做，只是为了触发 wp_head action hook
}

function track_wp_footer() {
    // 什么也不做，只是为了触发 wp_footer action hook
}

// 添加后台管理菜单
add_action( 'admin_menu', 'action_hook_tracker_menu' );

function action_hook_tracker_menu() {
    add_menu_page(
        'Action Hook Tracker', // 页面标题
        'Action Hooks', // 菜单标题
        'manage_options', // 权限
        'action-hook-tracker', // 菜单 slug
        'action_hook_tracker_page' // 回调函数
    );
}

// 后台管理页面内容
function action_hook_tracker_page() {
    $wp_head_count = did_action( 'wp_head' );
    $wp_footer_count = did_action( 'wp_footer' );

    echo '<div class="wrap">';
    echo '<h1>Action Hook Tracker</h1>';
    echo '<p><code>wp_head</code> has been fired <strong>' . $wp_head_count . '</strong> times.</p>';
    echo '<p><code>wp_footer</code> has been fired <strong>' . $wp_footer_count . '</strong> times.</p>';
    echo '</div>';
}

将这段代码保存为 action-hook-tracker.php 文件，然后上传到你的 WordPress 网站的 wp-content/plugins/ 目录下，激活这个插件，你就可以在 WordPress 后台管理界面看到一个名为 "Action Hooks" 的菜单，点击这个菜单，你就能看到 wp_head 和 wp_footer 这两个 action hook 被触发的次数了。

这个插件示例虽然简单，但它演示了 did_action() 的基本用法，以及如何将 did_action() 应用到实际的 WordPress 开发中。

好了，今天的讲座就到这里。希望通过今天的讲解，你对 did_action() 有了更深入的了解。记住，debug 的路上，我们永不孤单！祝大家编程愉快，bug 远离！

发表回复 取消回复

发表回复取消回复