发布于 由admin

剖析 WordPress `remove_action()` 与 `remove_filter()` 函数源码：从钩子数组中删除函数的原理。

各位观众老爷，大家好！今天咱来聊聊 WordPress 钩子系统里那两个“卸磨杀驴”的神器：remove_action() 和 remove_filter()。 别害怕，这俩货不是真杀驴，只是把绑在特定钩子上的函数给解绑了而已。

开场白：WordPress 钩子系统的基石

在深入剖析 remove_action() 和 remove_filter() 之前，咱们先简单回顾一下 WordPress 的钩子系统。 想象一下，WordPress 的核心代码就像一条高速公路，而钩子就像高速公路上的匝道。 你可以在特定的匝道（钩子）上挂载自己的代码（函数），从而在不修改核心代码的前提下，扩展 WordPress 的功能。

WordPress 主要有两种钩子：

  • 动作 (Action): 允许你在特定事件发生时执行代码。 例如，wp_head 动作允许你在 <head> 标签内添加自定义内容。
  • 过滤器 (Filter): 允许你修改数据。 例如，the_content 过滤器允许你修改文章的内容。

add_action() 和 add_filter() 是负责把你的函数“挂”到这些钩子上的。 那么，如果有一天，你觉得某个函数碍眼了，想把它从钩子上移除掉，就轮到 remove_action() 和 remove_filter() 出场了。

remove_action() 和 remove_filter()：殊途同归

remove_action() 和 remove_filter() 本质上做的是同一件事：从全局 $wp_filter 数组中移除指定钩子上的函数。 唯一的区别在于，remove_action() 用于移除 action 钩子上的函数，而 remove_filter() 用于移除 filter 钩子上的函数。 它们的用法几乎完全相同，所以咱们重点分析 remove_action()，remove_filter() 照猫画虎即可。

remove_action() 源码剖析：剥洋葱式解读

咱们直接上代码，看看 remove_action() 的真面目：

function remove_action( $tag, $function_to_remove, $priority = 10 ) {
    return remove_filter( $tag, $function_to_remove, $priority );
}

嘿！ 啥玩意？ remove_action() 竟然直接调用了 remove_filter()？ 没错！ 这俩货其实就是披着不同马甲的同一个人。 remove_action() 只是为了语义上的清晰而存在，实际上干活的是 remove_filter()。

所以，咱们的重点就放在 remove_filter() 上了。 remove_filter() 的源码如下：

function remove_filter( $tag, $function_to_remove, $priority = 10 ) {
    global $wp_filter, $merged_filters, $wp_current_filter;

    $idx = _wp_filter_build_unique_id( $tag, $function_to_remove, $priority );

    $r = false;
    if ( isset( $wp_filter[ $tag ][ $priority ][ $idx ] ) ) {
        unset( $wp_filter[ $tag ][ $priority ][ $idx ] );
        $r = true;
        if ( ! has_filter( $tag ) ) {
            return false;
        }
    }

    return $r;
}

别被这一堆变量吓到，咱们一步步来解读：

  1. global $wp_filter, $merged_filters, $wp_current_filter;: 这行代码声明了几个全局变量。 其中，$wp_filter 是最关键的，它是一个多维数组，存储了所有的钩子和挂载在上面的函数。 $merged_filters 和 $wp_current_filter 主要是用于优化和防止循环调用的，咱们暂时不用深究。

  2. $idx = _wp_filter_build_unique_id( $tag, $function_to_remove, $priority );: 这行代码调用了 _wp_filter_build_unique_id() 函数，生成一个唯一的 ID。 这个 ID 用于在 $wp_filter 数组中定位要移除的函数。 咱们来看看 _wp_filter_build_unique_id() 的源码：

    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
        return spl_object_hash( $function_to_add[0] ) . $function_to_add[1];
    } elseif ( is_string( $function_to_add[0] ) ) {
        // Static Calling
        return $function_to_add[0] . '::' . $function_to_add[1];
    }
}

    这个函数的作用是根据传入的函数名、对象和优先级，生成一个唯一的字符串 ID。 这个 ID 的生成方式会根据传入的 $function_to_add 的类型而有所不同：

    • 字符串 (string): 直接返回函数名。
    • 对象 (object): 返回对象的 SPL hash 值加上方法名。
    • 数组 (array): 如果数组的第一个元素是对象，则返回对象的 SPL hash 值加上方法名。 如果数组的第一个元素是字符串，则返回 "类名::方法名"。

    这个 ID 的目的是为了区分同名函数，尤其是当函数是对象方法或静态方法时。

  3. if ( isset( $wp_filter[ $tag ][ $priority ][ $idx ] ) ) { ... }: 这行代码检查 $wp_filter 数组中是否存在指定 tag、priority 和 idx 的元素。 如果存在，说明这个函数确实被挂载到了这个钩子上。

  4. unset( $wp_filter[ $tag ][ $priority ][ $idx ] );: 这行代码使用 unset() 函数，从 $wp_filter 数组中移除指定元素。 这就是“卸磨杀驴”的核心操作！

  5. $r = true;: 设置 $r 变量为 true，表示成功移除了函数。

  6. if ( ! has_filter( $tag ) ) { return false; }: 检查该$tag 对应的钩子是否还有其他函数，如果没有，则返回false.

  7. return $r;: 返回 $r 变量，表示是否成功移除了函数。

$wp_filter 数组的结构：钩子世界的藏宝图

为了更好地理解 remove_filter() 的工作原理，咱们需要深入了解一下 $wp_filter 数组的结构。 $wp_filter 是一个多维数组，其结构如下：

$wp_filter = array(
    'hook_name' => array(  // 钩子名称 (例如: 'wp_head', 'the_content')
        priority => array( // 优先级 (例如: 10, 20, 99)
            'unique_id' => array( // 函数的唯一 ID (例如: 'my_function', 'MyClass::my_method')
                'function' => 'callable', // 要执行的函数 (可以是函数名、对象方法、闭包等)
                'accepted_args' => int,  // 函数接受的参数数量
            ),
            'unique_id2' => array(
                'function' => 'callable',
                'accepted_args' => int,
            ),
            // ... 更多函数
        ),
        priority2 => array(
            // ... 更多函数
        ),
        // ... 更多优先级
    ),
    'hook_name2' => array(
        // ... 更多钩子
    ),
    // ... 更多钩子
);

这个数组的每一层都扮演着不同的角色：

  • 第一层 (钩子名称): 指定了要移除函数的钩子的名称。 例如，'wp_head' 或 'the_content'。
  • 第二层 (优先级): 指定了要移除函数的优先级。 优先级决定了函数执行的顺序。 优先级数值越小，函数执行得越早。
  • 第三层 (唯一 ID): 指定了要移除函数的唯一 ID。 这个 ID 是通过 _wp_filter_build_unique_id() 函数生成的。
  • 第四层 (函数信息): 包含了要执行的函数和它接受的参数数量。 这个信息在 remove_filter() 中并不重要，但在执行钩子时非常关键。

使用 remove_action() 和 remove_filter() 的注意事项：步步惊心

虽然 remove_action() 和 remove_filter() 用起来很简单，但还是有一些需要注意的地方，一不小心就会踩坑：

  1. 确保函数已经被挂载： remove_action() 和 remove_filter() 只能移除已经挂载的函数。 如果你试图移除一个不存在的函数，它们会默默地失败，没有任何提示。 所以，在移除函数之前，最好先确认它是否真的被挂载了。 可以使用 has_action() 和 has_filter() 函数来检查。

  2. 使用正确的函数名和优先级： remove_action() 和 remove_filter() 需要使用与 add_action() 和 add_filter() 相同的函数名和优先级才能成功移除函数。 如果函数名或优先级不匹配，它们也会默默地失败。

  3. 注意函数的作用域： 如果函数是在插件或主题中定义的，你需要确保在移除它的时候，插件或主题仍然处于激活状态。 否则，函数可能无法被找到，导致移除失败。

  4. 对象方法和静态方法： 如果要移除的是对象方法或静态方法，你需要使用与 add_action() 和 add_filter() 相同的数组形式来指定函数。 例如，array( $my_object, 'my_method' ) 或 array( 'MyClass', 'my_static_method' )。 同时，还需要注意对象的作用域，确保对象仍然存在。

  5. 移除匿名函数 (闭包): 移除匿名函数比较麻烦，因为你无法直接获取匿名函数的名称。 你需要将匿名函数赋值给一个变量，然后在 add_action() 和 remove_action() 中使用这个变量。 或者，可以使用 spl_object_hash() 获取匿名函数的唯一 ID，然后使用这个 ID 来移除函数。

代码示例：手把手教你“卸磨杀驴”

光说不练假把式，咱们来几个代码示例，让大家更直观地了解 remove_action() 和 remove_filter() 的用法：

示例 1：移除 wp_head 上的一个函数

// 挂载一个函数到 wp_head 钩子上
add_action( 'wp_head', 'my_custom_function' );

function my_custom_function() {
    echo '<meta name="description" content="This is my custom description.">';
}

// 移除这个函数
remove_action( 'wp_head', 'my_custom_function' );

示例 2：移除 the_content 上的一个过滤器

// 挂载一个过滤器到 the_content 钩子上
add_filter( 'the_content', 'my_content_filter' );

function my_content_filter( $content ) {
    return '<div class="my-custom-class">' . $content . '</div>';
}

// 移除这个过滤器
remove_filter( 'the_content', 'my_content_filter' );

示例 3：移除一个对象方法

class MyClass {
    public function my_method( $content ) {
        return $content . 'This is added by MyClass.';
    }
}

$my_object = new MyClass();

// 挂载对象方法
add_filter( 'the_content', array( $my_object, 'my_method' ) );

// 移除对象方法
remove_filter( 'the_content', array( $my_object, 'my_method' ) );

示例 4：移除一个匿名函数

// 挂载匿名函数
$my_anonymous_function = function( $content ) {
    return $content . 'This is added by anonymous function.';
};

add_filter( 'the_content', $my_anonymous_function );

// 移除匿名函数
remove_filter( 'the_content', $my_anonymous_function );

进阶技巧：灵活运用

除了基本的用法，remove_action() 和 remove_filter() 还可以与其他函数结合使用，实现更灵活的功能：

  • 条件移除： 可以根据条件判断是否需要移除函数。 例如，只在特定页面或特定用户角色下移除函数。

  • 动态移除： 可以在运行时动态地移除函数。 例如，根据用户的操作或配置文件的设置来移除函数。

  • 优先级控制： 可以根据需要调整函数的优先级，从而控制函数的执行顺序。

has_filter() 函数：侦察兵

has_filter() 函数可以用来检查一个钩子上是否已经挂载了指定的函数。 它的源码如下：

function has_filter( $tag, $function_to_check = false ) {
    global $wp_filter;

    $has = false;

    if ( ! isset( $wp_filter[ $tag ] ) || ! is_array( $wp_filter[ $tag ] ) ) {
        return false;
    }

    if ( false === $function_to_check ) {
        return true;
    }

    foreach ( $wp_filter[ $tag ] as $priority => $functions ) {
        if ( ! is_array( $functions ) ) {
            continue;
        }

        foreach ( $functions as $function ) {
            if ( $function['function'] === $function_to_check || ( is_array( $function['function'] ) && $function['function'][0] === $function_to_check ) ) {
                $has = true;
                break 2;
            }
        }
    }

    return $has;
}

这个函数会遍历 $wp_filter 数组，查找指定 tag 和 function_to_check 的函数。 如果找到了，就返回 true，否则返回 false。

总结：一招鲜，吃遍天

remove_action() 和 remove_filter() 是 WordPress 钩子系统中非常重要的两个函数。 它们允许你在不修改核心代码的前提下，灵活地移除钩子上的函数，从而定制 WordPress 的功能。 掌握了这两个函数，你就掌握了 WordPress 定制的钥匙。

表格总结

函数名称 功能 参数 返回值
remove_action() 从指定的动作钩子上移除一个函数。 $tag (string): 动作钩子的名称。
$function_to_remove (callable): 要移除的函数名称。
$priority (int, optional): 优先级。默认为 10。		 (bool) 如果成功移除函数，则返回 true。如果函数未被挂载或移除失败，则返回 false。
remove_filter() 从指定的过滤器钩子上移除一个函数。 $tag (string): 过滤器钩子的名称。
$function_to_remove (callable): 要移除的函数名称。
$priority (int, optional): 优先级。默认为 10。		 (bool) 如果成功移除函数，则返回 true。如果函数未被挂载或移除失败，则返回 false。
has_action() 检查指定的动作钩子上是否已经挂载了函数。 $tag (string): 动作钩子的名称。
$function_to_check (callable, optional): 要检查的函数名称。如果省略此参数，则检查钩子上是否挂载了任何函数。		 (bool) 如果钩子上挂载了函数，则返回 true。如果钩子上没有挂载函数或指定函数未被挂载，则返回 false。
has_filter() 检查指定的过滤器钩子上是否已经挂载了函数。 $tag (string): 过滤器钩子的名称。
$function_to_check (callable, optional): 要检查的函数名称。如果省略此参数，则检查钩子上是否挂载了任何函数。		 (bool) 如果钩子上挂载了函数，则返回 true。如果钩子上没有挂载函数或指定函数未被挂载，则返回 false。
_wp_filter_build_unique_id() 为一个函数生成一个唯一的 ID，用于在 $wp_filter 数组中存储和查找函数。 $tag (string): 钩子的名称。
$function_to_add (callable): 要添加的函数名称。
$priority (int): 优先级。		 (string) 函数的唯一 ID。

好了，今天的讲座就到这里。 希望大家以后在使用 remove_action() 和 remove_filter() 的时候，能够更加得心应手，把 WordPress 玩转得溜溜的！ 咱们下期再见！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注