WordPress源码深度解析之：`WordPress`的`Filter`机制：`add_filter()`和`remove_filter()`的内部工作原理。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，大家好！我是你们的老朋友，今天咱们不聊风花雪月，只谈代码江湖里的恩怨情仇。今天的主题是WordPress的Filter机制，特别是add_filter()和remove_filter()这对相爱相杀的好基友。

咱们今天要讲的，可不是简单的“这俩函数用来干啥”，而是要深入到它们的骨髓里，看看它们是如何运作的，以及在WordPress这个庞大的生态系统中扮演了什么角色。准备好了吗？系好安全带，咱们发车了！

一、什么是Filter？为什么要用Filter？

在开始深入代码之前，咱们先来聊聊哲学…好吧，其实没那么玄乎。想象一下，你是一家餐厅的老板，你提供一份基础款的汉堡，但是顾客的要求千奇百怪：有人要加酸黄瓜，有人不要番茄酱，有人甚至要用菠萝代替肉饼（口味真独特）。

Filter机制，就像是餐厅里的“定制”功能。WordPress提供了一份“原始”的数据（比如文章的内容，评论，等等），但是开发者可以通过Filter，在这些数据被最终展示或者使用之前，进行修改、加工、甚至替换。

为什么要用Filter呢？原因很简单：

可扩展性: WordPress的核心代码是稳定的，但需求是不断变化的。Filter允许开发者在不修改核心代码的前提下，增加或修改WordPress的功能。
解耦: Filter将不同的功能模块解耦。一个插件可以通过Filter修改另一个插件的数据，而不需要直接依赖于另一个插件的代码。
灵活性: Filter提供了极大的灵活性。开发者可以根据自己的需求，选择性地应用或移除Filter。

二、add_filter()：我要插队！

add_filter()函数，是Filter机制的核心。它的作用是：将一个函数（也就是“定制”方案）注册到特定的Filter钩子上。

函数原型如下：

add_filter( string $tag, callable $function_to_add, int $priority = 10, int $accepted_args = 1 ) : true

别被这些参数吓到，咱们一个一个来解释：

$tag：这是Filter的名称，也就是“钩子”。你可以把它想象成餐厅里的“订单类型”，比如the_content（文章内容）、comment_text（评论内容）等等。
$function_to_add：这是你要执行的函数（也就是“定制”方案）。这个函数会接收WordPress传递过来的数据，并返回修改后的数据。
$priority：这是优先级。数值越小，优先级越高（越早执行）。默认值是10。你可以把它想象成“VIP等级”，VIP等级越高，你的“定制”方案就越早被执行。
$accepted_args：这个参数指定了你的函数希望接收多少个参数。默认值是1。WordPress会根据这个值，传递相应数量的参数给你的函数。

举个例子：假设你想在文章内容后面添加一段版权信息，你可以这样做：

function my_add_copyright( $content ) {
  $copyright = '<p>Copyright © 2023 My Website</p>';
  return $content . $copyright;
}

add_filter( 'the_content', 'my_add_copyright' );

这段代码的意思是：

定义一个名为my_add_copyright的函数，它接收一个参数$content（文章内容），并在其后面添加版权信息。
使用add_filter()函数，将my_add_copyright函数注册到the_content钩子上。这意味着，当WordPress准备显示文章内容时，会先执行my_add_copyright函数，对其进行修改。

三、remove_filter()：我要取消！

remove_filter()函数，顾名思义，是用来移除之前通过add_filter()注册的函数的。

函数原型如下：

remove_filter( string $tag, callable $function_to_remove, int $priority = 10 ) : bool

参数解释：

$tag：要移除的Filter的名称。必须与add_filter()时使用的$tag一致。
$function_to_remove：要移除的函数。必须与add_filter()时使用的$function_to_add一致。
$priority：要移除的函数的优先级。必须与add_filter()时使用的$priority一致。

注意：remove_filter()必须精确匹配add_filter()时使用的所有参数（$tag、$function_to_remove和$priority），才能成功移除。

举个例子：如果你想移除上面例子中添加的版权信息，你可以这样做：

remove_filter( 'the_content', 'my_add_copyright' );

四、幕后英雄：$wp_filter全局变量

现在，咱们要深入到WordPress的核心代码，看看add_filter()和remove_filter()是如何实现的。

在WordPress中，所有的Filter信息都存储在一个名为$wp_filter的全局变量中。$wp_filter是一个多维数组，其结构如下：

$wp_filter = array(
  'filter_name' => array( // Filter 的名称，比如 'the_content'
    priority => array( // 优先级，比如 10
      unique_id => array( // 函数的唯一标识符
        'function' => 'callable', // 要执行的函数
        'accepted_args' => int // 函数接收的参数个数
      )
    )
  )
);

add_filter()函数的作用，就是向$wp_filter数组中添加一条记录。remove_filter()函数的作用，就是从$wp_filter数组中删除一条记录。

为了更好地理解，咱们来看一下add_filter()函数的简化版实现：

function my_add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
  global $wp_filter;

  // 生成函数的唯一标识符
  $unique_id = _wp_filter_build_unique_id( $tag, $function_to_add, $priority );

  // 如果该 Filter 钩子不存在，则创建一个新的数组
  if ( ! isset( $wp_filter[ $tag ] ) ) {
    $wp_filter[ $tag ] = array();
  }

  // 如果该优先级不存在，则创建一个新的数组
  if ( ! isset( $wp_filter[ $tag ][ $priority ] ) ) {
    $wp_filter[ $tag ][ $priority ] = array();
  }

  // 将函数信息添加到 $wp_filter 数组中
  $wp_filter[ $tag ][ $priority ][ $unique_id ] = array(
    'function' => $function_to_add,
    'accepted_args' => $accepted_args
  );

  return true;
}

function _wp_filter_build_unique_id( $tag, $function, $priority ) {
    static $filter_id_count = 0;

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

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

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

这段代码的主要逻辑是：

声明 $wp_filter 为全局变量。
生成函数的唯一标识符。
检查 $wp_filter 数组中是否存在指定的 $tag 和 $priority。如果不存在，则创建相应的数组。
将函数信息（function 和 accepted_args）添加到 $wp_filter 数组中。

再来看一下remove_filter()函数的简化版实现：

function my_remove_filter( $tag, $function_to_remove, $priority = 10 ) {
  global $wp_filter;

  // 生成函数的唯一标识符
  $unique_id = _wp_filter_build_unique_id( $tag, $function_to_remove, $priority );

  // 检查 $wp_filter 数组中是否存在指定的 $tag 和 $priority
  if ( isset( $wp_filter[ $tag ][ $priority ][ $unique_id ] ) ) {
    // 从 $wp_filter 数组中删除函数信息
    unset( $wp_filter[ $tag ][ $priority ][ $unique_id ] );

    // 如果该优先级下没有其他函数，则删除该优先级
    if ( empty( $wp_filter[ $tag ][ $priority ] ) ) {
      unset( $wp_filter[ $tag ][ $priority ] );
    }

    // 如果该 Filter 钩子下没有其他优先级，则删除该 Filter 钩子
    if ( empty( $wp_filter[ $tag ] ) ) {
      unset( $wp_filter[ $tag ] );
    }

    return true;
  }

  return false;
}

这段代码的主要逻辑是：

声明 $wp_filter 为全局变量。
生成函数的唯一标识符。
检查 $wp_filter 数组中是否存在指定的 $tag、$priority和唯一标识符。如果存在，则删除对应的函数信息。
如果该优先级下没有其他函数，则删除该优先级。
如果该 Filter 钩子下没有其他优先级，则删除该 Filter 钩子。

五、apply_filters()：启动！变形！

apply_filters()函数，是用来触发Filter的。它的作用是：从$wp_filter数组中获取指定Filter钩子上的所有函数，并按照优先级顺序依次执行。

函数原型如下：

apply_filters( string $tag, mixed $value, mixed ...$args ) : mixed

参数解释：

$tag：要触发的Filter的名称。
$value：要传递给Filter函数的初始值。
...$args：要传递给Filter函数的其他参数。

举个例子：WordPress在显示文章内容时，会使用apply_filters()函数来触发the_content钩子：

$content = apply_filters( 'the_content', $content );

这段代码的意思是：

调用apply_filters()函数，触发the_content钩子。
将$content变量作为初始值传递给the_content钩子上的所有函数。
按照优先级顺序依次执行the_content钩子上的所有函数，并将每个函数的返回值传递给下一个函数。
将最后一个函数的返回值赋值给$content变量。

咱们来看一下apply_filters()函数的简化版实现：

function my_apply_filters( $tag, $value ) {
  global $wp_filter;

  // 如果该 Filter 钩子不存在，则直接返回原始值
  if ( ! isset( $wp_filter[ $tag ] ) ) {
    return $value;
  }

  // 将所有优先级排序
  ksort( $wp_filter[ $tag ] );

  // 遍历所有优先级
  foreach ( $wp_filter[ $tag ] as $priority => $functions ) {
    // 遍历该优先级下的所有函数
    foreach ( $functions as $function ) {
      // 根据函数接收的参数个数，传递相应数量的参数
      $accepted_args = $function['accepted_args'];
      $args = array_slice( func_get_args(), 1, $accepted_args );

      // 执行函数，并将返回值赋值给 $value
      $value = call_user_func_array( $function['function'], $args );
    }
  }

  return $value;
}

这段代码的主要逻辑是：

声明 $wp_filter 为全局变量。
检查 $wp_filter 数组中是否存在指定的 $tag。如果不存在，则直接返回原始值。
将所有优先级排序。
遍历所有优先级，并遍历该优先级下的所有函数。
根据函数接收的参数个数，传递相应数量的参数。
使用call_user_func_array()函数执行函数，并将返回值赋值给$value变量。

六、注意事项

优先级: 优先级非常重要，因为它决定了Filter函数的执行顺序。如果你的Filter函数依赖于其他Filter函数的输出，那么你需要确保你的Filter函数具有合适的优先级。
参数个数: 确保你的Filter函数接收的参数个数与add_filter()函数中指定的$accepted_args一致。否则，可能会导致错误。
命名冲突: 避免使用与WordPress核心代码或其他插件相同的Filter名称。
性能: 过多的Filter会影响WordPress的性能。尽量减少Filter的使用，并优化Filter函数的代码。
移除Filter: 某些主题或插件可能不正确地使用了匿名函数作为 filter 的 callback 函数. 此时, remove_filter 将不起作用. 因为匿名函数没有名字, remove_filter 无法匹配到正确的函数.

七、总结

Filter机制是WordPress的核心机制之一，它提供了极大的可扩展性和灵活性。add_filter()和remove_filter()是Filter机制的两个重要组成部分，它们分别用于注册和移除Filter函数。apply_filters()函数用于触发Filter。

理解Filter机制的内部工作原理，可以帮助你更好地开发WordPress插件和主题，并解决一些常见的问题。

好了，今天的讲座就到这里。希望大家有所收获！如果大家还有什么疑问，欢迎在评论区留言。咱们下期再见！

发表回复 取消回复

发表回复取消回复