剖析 WordPress 钩子系统中 add_action 与 add_filter 的本质实现 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress 钩子系统深度剖析：`add_action` 与 `add_filter` 的本质实现

各位同学，大家好！今天我们来深入探讨 WordPress 钩子系统的核心：add_action 和 add_filter。理解它们的底层实现对于我们编写高效、可维护的 WordPress 代码至关重要。

什么是钩子系统？

在深入 add_action 和 add_filter 之前，我们先简单回顾一下钩子系统的概念。WordPress 钩子系统允许我们在不修改 WordPress 核心代码的情况下，插入自定义功能或修改已有功能。它就像代码中的“钩子”，允许我们“挂载”自己的代码，在特定事件发生时执行。

add_action 与 add_filter 的区别

add_action: 用于注册一个在特定动作发生时执行的函数。它主要用于执行某些操作，例如发送邮件、更新数据库等。动作（Action）通常不期望返回值。
add_filter: 用于注册一个函数，该函数可以修改其他函数或变量的值。过滤器（Filter）期望返回一个修改后的值。

内部数据结构：$wp_filter 全局变量

WordPress 使用一个全局变量 $wp_filter 来存储所有注册的动作和过滤器。$wp_filter 是一个多维数组，其结构大致如下：

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

hook_name: 钩子的名称，例如 'publish_post' 或 'the_content'。
priority: 优先级，数值越小优先级越高，决定了回调函数的执行顺序。
callback_identifier: 回调函数的唯一标识符，通常基于函数名或类名和方法名生成，用于后续移除钩子。
function: 回调函数的名称。
accepted_args: 回调函数期望接收的参数数量。

add_action 的实现

add_action 函数的本质是将一个函数添加到 $wp_filter 数组中。它的基本语法如下：

add_action( string $hook_name, callable $callback, int $priority = 10, int $accepted_args = 1 );

让我们逐步分析 add_action 的一个简化实现：

function my_add_action( $hook_name, $callback, $priority = 10, $accepted_args = 1 ) {
    global $wp_filter;

    // 1. 确保 $hook_name 是字符串
    if ( ! is_string( $hook_name ) ) {
        return false;
    }

    // 2. 确保 $callback 是可调用的
    if ( ! is_callable( $callback ) ) {
        return false;
    }

    // 3. 如果 $hook_name 尚未存在，则初始化它
    if ( ! isset( $wp_filter[ $hook_name ] ) ) {
        $wp_filter[ $hook_name ] = array();
    }

    // 4. 如果 $priority 尚未存在，则初始化它
    if ( ! isset( $wp_filter[ $hook_name ][ $priority ] ) ) {
        $wp_filter[ $hook_name ][ $priority ] = array();
    }

    // 5. 生成回调函数的唯一标识符
    $callback_identifier = _wp_filter_build_unique_id( $hook_name, $callback, $priority );

    // 6. 将回调函数添加到 $wp_filter 数组中
    $wp_filter[ $hook_name ][ $priority ][ $callback_identifier ] = array(
        'function' => $callback,
        'accepted_args' => $accepted_args
    );

    return true;
}

// 用于生成唯一标识符的辅助函数
function _wp_filter_build_unique_id( $hook_name, $callback, $priority ) {
    static $filter_id_count = 0;

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

    if ( is_object( $callback ) ) {
        // Closures are currently implemented as objects
        $callback = array( $callback, '' );
    } else {
        $callback = (array) $callback;
    }

    if (is_object( $callback[0])) {
        return spl_object_hash( $callback[0] ) . $callback[1];
    } elseif ( is_string( $callback[0] ) ) {
        return $callback[0] . '::' . $callback[1];
    }
    return false;
}

代码解释：

参数验证： add_action 首先验证 $hook_name 是否为字符串，$callback 是否为可调用函数。
初始化数组： 如果 $hook_name 或 $priority 在 $wp_filter 中不存在，则初始化相应的数组。
生成唯一标识符： 使用 _wp_filter_build_unique_id 函数生成回调函数的唯一标识符。这对于后续移除钩子非常重要。这个函数可以处理函数名，对象方法，静态方法，匿名函数等多种类型的回调。
添加回调函数： 将回调函数及其参数信息添加到 $wp_filter 数组中，索引为 $hook_name、$priority 和 $callback_identifier。

add_filter 的实现

add_filter 的实现与 add_action 非常相似，本质上也是将一个函数添加到 $wp_filter 数组中。唯一的区别在于，add_filter 的回调函数期望返回一个修改后的值，而 add_action 的回调函数通常不返回值。

function my_add_filter( $hook_name, $callback, $priority = 10, $accepted_args = 1 ) {
    global $wp_filter;

    // 与 add_action 的实现基本相同
    if ( ! is_string( $hook_name ) ) {
        return false;
    }

    if ( ! is_callable( $callback ) ) {
        return false;
    }

    if ( ! isset( $wp_filter[ $hook_name ] ) ) {
        $wp_filter[ $hook_name ] = array();
    }

    if ( ! isset( $wp_filter[ $hook_name ][ $priority ] ) ) {
        $wp_filter[ $hook_name ][ $priority ] = array();
    }

    $callback_identifier = _wp_filter_build_unique_id( $hook_name, $callback, $priority );

    $wp_filter[ $hook_name ][ $priority ][ $callback_identifier ] = array(
        'function' => $callback,
        'accepted_args' => $accepted_args
    );

    return true;
}

触发钩子：do_action 和 apply_filters

现在我们已经了解了如何注册钩子，接下来我们需要了解如何触发这些钩子。WordPress 提供了 do_action 和 apply_filters 函数来完成这个任务。

do_action 的实现

do_action 函数用于触发一个动作。它的基本语法如下：

do_action( string $hook_name, mixed ...$args );

do_action 的一个简化实现如下：

function my_do_action( $hook_name, ...$args ) {
    global $wp_filter;

    // 1. 检查钩子是否存在
    if ( ! isset( $wp_filter[ $hook_name ] ) ) {
        return;
    }

    // 2. 获取所有已注册的回调函数
    $callbacks = $wp_filter[ $hook_name ];

    // 3. 根据优先级排序回调函数
    ksort( $callbacks );

    // 4. 遍历并执行回调函数
    foreach ( $callbacks as $priority => $functions ) {
        foreach ( $functions as $function ) {
            call_user_func_array( $function['function'], array_slice( $args, 0, $function['accepted_args'] ) );
        }
    }
}

代码解释：

检查钩子是否存在： do_action 首先检查 $hook_name 是否在 $wp_filter 中存在。如果不存在，则表示没有注册任何回调函数，直接返回。
获取回调函数： 获取 $hook_name 对应的所有回调函数。
排序回调函数： 使用 ksort 函数根据优先级对回调函数进行排序，确保按照优先级顺序执行。
执行回调函数： 遍历已排序的回调函数，使用 call_user_func_array 函数执行每个回调函数。array_slice 用于传递正确数量的参数给回调函数，避免参数数量不匹配的问题。

apply_filters 的实现

apply_filters 函数用于触发一个过滤器。它的基本语法如下：

apply_filters( string $hook_name, mixed $value, mixed ...$args );

apply_filters 的一个简化实现如下：

function my_apply_filters( $hook_name, $value, ...$args ) {
    global $wp_filter;

    // 1. 检查钩子是否存在
    if ( ! isset( $wp_filter[ $hook_name ] ) ) {
        return $value;
    }

    // 2. 获取所有已注册的回调函数
    $callbacks = $wp_filter[ $hook_name ];

    // 3. 根据优先级排序回调函数
    ksort( $callbacks );

    // 4. 遍历并执行回调函数
    foreach ( $callbacks as $priority => $functions ) {
        foreach ( $functions as $function ) {
            $value = call_user_func_array( $function['function'], array_merge( array( $value ), array_slice( $args, 0, $function['accepted_args'] -1 ) ) );
        }
    }

    // 5. 返回最终修改后的值
    return $value;
}

代码解释：

检查钩子是否存在： apply_filters 首先检查 $hook_name 是否在 $wp_filter 中存在。如果不存在，则直接返回原始的 $value。
获取回调函数： 获取 $hook_name 对应的所有回调函数。
排序回调函数： 使用 ksort 函数根据优先级对回调函数进行排序，确保按照优先级顺序执行。
执行回调函数： 遍历已排序的回调函数，使用 call_user_func_array 函数执行每个回调函数。注意，apply_filters 的第一个参数是 $value，它会被传递给第一个回调函数，然后每个回调函数都会修改并返回这个值，最终 apply_filters 返回的是经过所有回调函数修改后的 $value。array_merge 用于将初始值和额外的参数合并成一个参数数组传递给回调函数。这里array_slice( $args, 0, $function['accepted_args'] -1 ) 是因为value已经算作一个参数了。
返回修改后的值： 返回经过所有回调函数修改后的 $value。

移除钩子：remove_action 和 remove_filter

WordPress 提供了 remove_action 和 remove_filter 函数来移除已经注册的钩子。这两个函数的实现都依赖于前面提到的回调函数的唯一标识符。

remove_action 和 remove_filter 的实现

function my_remove_action( $hook_name, $callback, $priority = 10 ) {
    return my_remove_filter( $hook_name, $callback, $priority );
}

function my_remove_filter( $hook_name, $callback, $priority = 10 ) {
    global $wp_filter;

    $callback_identifier = _wp_filter_build_unique_id( $hook_name, $callback, $priority );

    if ( empty( $callback_identifier ) ) {
        return false;
    }

    if ( isset( $wp_filter[ $hook_name ][ $priority ][ $callback_identifier ] ) ) {
        unset( $wp_filter[ $hook_name ][ $priority ][ $callback_identifier ] );

        // Clean up empty priority arrays
        if ( empty( $wp_filter[ $hook_name ][ $priority ] ) ) {
            unset( $wp_filter[ $hook_name ][ $priority ] );
        }

        // Clean up empty hook arrays
        if ( empty( $wp_filter[ $hook_name ] ) ) {
            unset( $wp_filter[ $hook_name ] );
        }

        return true;
    }

    return false;
}

代码解释：

生成唯一标识符： 使用 _wp_filter_build_unique_id 函数生成要移除的回调函数的唯一标识符。
检查钩子是否存在： 检查 $wp_filter 数组中是否存在对应的钩子。
移除回调函数： 如果存在，则使用 unset 函数从 $wp_filter 数组中移除该回调函数。
清理数组： 如果移除回调函数后，优先级数组或钩子数组为空，则清理这些空数组，以节省内存。

一个完整的例子

<?php

// 注册一个 action
add_action( 'my_custom_action', 'my_custom_function', 10, 2 );

function my_custom_function( $arg1, $arg2 ) {
    echo "Action triggered with arguments: " . $arg1 . ", " . $arg2 . "<br>";
}

// 注册一个 filter
add_filter( 'my_custom_filter', 'my_custom_filter_function', 10, 1 );

function my_custom_filter_function( $value ) {
    return "Modified: " . $value;
}

// 触发 action
do_action( 'my_custom_action', 'value1', 'value2' );

// 应用 filter
$filtered_value = apply_filters( 'my_custom_filter', 'original value' );
echo "Filtered value: " . $filtered_value . "<br>";

// 移除 action
remove_action( 'my_custom_action', 'my_custom_function' );

// 移除 filter
remove_filter( 'my_custom_filter', 'my_custom_filter_function' );

// 再次触发 action (不会执行)
do_action( 'my_custom_action', 'value1', 'value2' );

// 再次应用 filter (返回原始值)
$filtered_value = apply_filters( 'my_custom_filter', 'original value' );
echo "Filtered value after removal: " . $filtered_value . "<br>";

?>

输出结果:

Action triggered with arguments: value1, value2
Filtered value: Modified: original value
Filtered value after removal: original value

表格总结：函数功能对比

函数	功能	期望返回值
`add_action`	注册一个函数，该函数在特定的动作发生时执行。主要用于执行操作，例如发送邮件、更新数据库等。	无
`add_filter`	注册一个函数，该函数可以修改其他函数或变量的值。	修改后的值
`do_action`	触发一个动作，执行所有已注册的与该动作相关的函数。	无
`apply_filters`	触发一个过滤器，将一个值传递给所有已注册的与该过滤器相关的函数，并返回经过所有函数修改后的值。	修改后的值
`remove_action`	移除一个先前使用 `add_action` 注册的函数。	无
`remove_filter`	移除一个先前使用 `add_filter` 注册的函数。	无

深入理解钩子系统

通过以上分析，我们可以看到 add_action 和 add_filter 的本质都是将回调函数添加到 $wp_filter 全局数组中。do_action 和 apply_filters 则负责从 $wp_filter 数组中获取回调函数并执行。理解这些函数的底层实现，可以帮助我们更好地使用 WordPress 钩子系统，编写更高效、更可维护的代码。

钩子系统的灵活性

WordPress 钩子系统提供了极大的灵活性，允许开发者在不修改核心代码的情况下，扩展和定制 WordPress 的功能。通过合理使用钩子，我们可以构建复杂的插件和主题，满足各种需求。

注意事项

优先级： 合理设置优先级，确保回调函数按照正确的顺序执行。
参数数量： 确保回调函数接收的参数数量与 accepted_args 参数一致。
移除钩子： 在不再需要时，及时移除已注册的钩子，避免不必要的性能开销。

钩子系统的核心与应用

add_action 和 add_filter 的核心在于全局数组 $wp_filter 的管理，并通过 do_action 和 apply_filters 实现了代码的解耦和扩展。深入理解这些机制，能更好地利用 WordPress 的插件系统，定制所需功能。

WordPress 钩子系统深度剖析：add_action 与 add_filter 的本质实现

发表回复 取消回复

WordPress 钩子系统深度剖析：`add_action` 与 `add_filter` 的本质实现

发表回复取消回复