分析 `wp_update_term()` 函数的源码，它是如何处理分类术语的更新和其计数更新的？

各位观众老爷，大家好！今天咱们来聊聊 WordPress 里面的一个“老伙计” – wp_update_term() 函数。这玩意儿，听起来平平无奇，但它可是分类术语（taxonomy term）的“幕后推手”，负责更新它们的各种信息，包括计数。今天，咱们就扒开它的源码，看看它到底是怎么运作的，尤其是那个计数更新，里面可是藏着不少小九九。

开场白：术语更新的重要性

在WordPress的世界里，分类术语（比如文章分类、标签等）是组织内容的关键。想象一下，如果没有分类，你的博客就像一个堆满杂物的房间，找东西简直是噩梦。而wp_update_term()就是帮你整理这个房间，让你的分类术语井井有条。

那么，为什么要更新术语呢？原因有很多：

• 名称变更： 比如，你觉得“编程入门”这个分类名字不够吸引人，想改成“代码新手村”，那就需要更新术语名称。
• 别名调整： 别名（slug）是URL的一部分，对于SEO很重要。如果你的别名不友好，也需要更新。
• 描述修改： 术语的描述可以帮助用户了解这个分类的内容。如果描述不够准确，需要更新。
• 父级分类变更： 如果你需要调整分类之间的层级关系，也需要更新术语。
• 计数更新： 当文章所属的分类发生变化时，需要更新分类术语的计数，以反映该分类下文章的数量。

好了，废话不多说，咱们直接进入主题，开始源码分析！

第一部分：wp_update_term() 函数概览

wp_update_term() 函数位于 wp-includes/taxonomy.php 文件中。它的基本作用就是更新分类术语的信息，并将更新后的数据保存到数据库中。

函数原型：

function wp_update_term( $term_id, $taxonomy, $args = array() ) {
  // 函数体
}

• $term_id: 要更新的术语 ID。必须是整数。
• $taxonomy: 术语所属的分类名称（例如：category、post_tag）。
• $args: 一个数组，包含要更新的术语属性，例如：name、slug、description、parent。

返回值：

• 成功时，返回一个数组，包含：
  • term_id: 更新后的术语 ID。
  • term_taxonomy_id: 更新后的术语关系 ID。
• 失败时，返回一个 WP_Error 对象，包含错误信息。

第二部分：源码解读（核心部分）

我们来逐行解读 wp_update_term() 的核心代码，重点关注计数更新的部分。

1. 参数校验和准备工作

  $term_id = (int) $term_id;

  if ( ! term_exists( $term_id, $taxonomy ) ) {
    return new WP_Error( 'invalid_term', __( 'Invalid term ID.' ) );
  }

  $taxonomy = sanitize_key( $taxonomy );

  $defaults = array(
    'name'        => '',
    'slug'        => '',
    'description' => '',
    'parent'      => 0
  );

  $args = wp_parse_args( $args, $defaults );

  $name        = sanitize_term_field( 'name', $args['name'], $term_id, $taxonomy, 'db' );
  $slug        = sanitize_term_field( 'slug', $args['slug'], $term_id, $taxonomy, 'db' );
  $description = sanitize_term_field( 'description', $args['description'], $term_id, $taxonomy, 'db' );
  $parent      = (int) $args['parent'];

这段代码主要做了以下几件事：

• 将 $term_id 转换为整数，确保类型正确。
• 使用 term_exists() 函数检查术语是否存在。如果不存在，直接返回错误。
• 对 $taxonomy 进行清理，确保它是一个有效的分类名称。
• 使用 wp_parse_args() 函数合并传入的 $args 和默认值 $defaults，确保所有的属性都有值。
• 使用 sanitize_term_field() 函数对 $name、$slug 和 $description 进行清理，防止恶意代码注入。
• 将 $parent 转换为整数。

2. 检查是否需要更新

  $term = get_term( $term_id, $taxonomy );

  if ( is_wp_error( $term ) ) {
    return $term;
  }

  if ( $name === $term->name && $slug === $term->slug && $description === $term->description && $parent === (int) $term->parent ) {
    return array( 'term_id' => $term_id, 'term_taxonomy_id' => $term->term_taxonomy_id );
  }

这段代码首先使用 get_term() 函数获取术语的当前信息。如果获取失败，直接返回错误。然后，它会比较新的属性值和旧的属性值，如果所有属性都没有变化，说明不需要更新，直接返回。

3. 更新术语信息

  $data = array(
    'name' => $name,
    'slug' => $slug
  );

  $where = array( 'term_id' => $term_id );

  $updated = $wpdb->update( $wpdb->terms, $data, $where );

  if ( false === $updated ) {
    return new WP_Error( 'db_update_error', __( 'Could not update term.' ), $wpdb->last_error );
  }

这段代码使用 $wpdb->update() 函数更新 wp_terms 表中的术语信息。如果更新失败，直接返回错误。

4. 更新术语关系信息

  $tt_id = $term->term_taxonomy_id;

  $data = array(
    'description' => $description,
    'parent'      => $parent
  );

  $where = array( 'term_taxonomy_id' => $tt_id );

  $updated = $wpdb->update( $wpdb->term_taxonomy, $data, $where );

  if ( false === $updated ) {
    return new WP_Error( 'db_update_error', __( 'Could not update term taxonomy.' ), $wpdb->last_error );
  }

这段代码使用 $wpdb->update() 函数更新 wp_term_taxonomy 表中的术语关系信息。如果更新失败，直接返回错误。

5. 清理缓存

  clean_term_cache( $term_id, $taxonomy );

这段代码使用 clean_term_cache() 函数清理术语缓存，确保下次获取术语信息时，能够获取到最新的数据。

6. 返回结果

  return array( 'term_id' => $term_id, 'term_taxonomy_id' => $tt_id );

这段代码返回一个数组，包含更新后的术语 ID 和术语关系 ID。

第三部分：计数更新（重头戏来了！）

wp_update_term() 函数本身并不直接更新术语的计数。术语的计数是由 wp_update_term_count() 函数负责的。但是，wp_update_term() 函数的更新操作，可能会间接影响到术语的计数，因此我们需要了解 wp_update_term_count() 函数是如何工作的。

wp_update_term_count() 函数

这个函数才是真正负责更新分类术语计数的“大力士”。它会根据分类下的文章数量，更新 wp_term_taxonomy 表中的 count 字段。

函数原型：

function wp_update_term_count( $terms, $taxonomy, $do_object_terms = true ) {
    // 函数体
}

• $terms: 一个包含要更新计数的术语 ID 的数组。
• $taxonomy: 术语所属的分类名称。
• $do_object_terms: 是否更新与这些术语关联的对象（例如文章）的术语缓存。

源码解读：

function wp_update_term_count( $terms, $taxonomy, $do_object_terms = true ) {
  global $wpdb;

  $terms = array_map( 'intval', (array) $terms );
  $terms = array_unique( $terms );

  if ( empty( $terms ) ) {
    return;
  }

  $object_types = (array) apply_filters( 'get_objects_for_term', array( 'post' ), $terms, $taxonomy );

  foreach ( $object_types as $object_type ) {
    $table = _wp_term_recount_get_table( $taxonomy, $object_type );

    if ( ! $table ) {
      continue;
    }

    $id = sanitize_key( $taxonomy . '_' . $object_type );

    /**
     * Filters the query used to update the term count.
     *
     * @since 5.1.0
     *
     * @param string   $query       The query to run to update the term count.
     * @param string   $taxonomy    Taxonomy being updated.
     * @param string   $object_type Object type being updated.
     * @param int[]    $terms       Array of term IDs being updated.
     */
    $query = apply_filters(
      'update_term_count_query',
      "UPDATE {$wpdb->term_taxonomy} SET count = (
        SELECT COUNT(*) FROM {$table} AS oot
        WHERE oot.term_taxonomy_id = {$wpdb->term_taxonomy}.term_taxonomy_id
      ) WHERE taxonomy = %s AND term_id IN (" . implode( ',', $terms ) . ')',
      $taxonomy,
      $object_type,
      $terms
    );

    $wpdb->query( $wpdb->prepare( $query, $taxonomy ) );
  }

  if ( $do_object_terms ) {
    foreach ( $terms as $term ) {
      wp_cache_delete_by_group( 'term_relationships' );
      clean_term_cache( $term, $taxonomy, false );
    }
  }
}

这段代码的逻辑如下：

1. 参数处理： 将 $terms 转换为整数数组，并去除重复的术语 ID。
2. 获取对象类型： 使用 apply_filters( 'get_objects_for_term' ) 钩子，获取与这些术语关联的对象类型（默认为 post，即文章）。
3. 循环处理对象类型： 循环遍历每个对象类型，构建 SQL 查询语句，更新 wp_term_taxonomy 表中的 count 字段。
4. 构建 SQL 查询语句： SQL查询语句的核心在于计算每个术语下的文章数量。它通过子查询来实现，子查询从关联表中（例如 wp_term_relationships）统计每个术语的文章数量，然后更新 wp_term_taxonomy 表。
5. 执行 SQL 查询： 使用 $wpdb->query() 函数执行 SQL 查询，更新计数。
6. 清理缓存： 如果 $do_object_terms 为 true，则清理术语缓存和关系缓存。

核心的 SQL 查询语句：

UPDATE {$wpdb->term_taxonomy} SET count = (
  SELECT COUNT(*) FROM {$table} AS oot
  WHERE oot.term_taxonomy_id = {$wpdb->term_taxonomy}.term_taxonomy_id
) WHERE taxonomy = %s AND term_id IN (" . implode( ',', $terms ) . ')

这个 SQL 查询语句的含义是：

• 更新 wp_term_taxonomy 表中的 count 字段。
• count 字段的值是通过子查询计算出来的。
• 子查询从关联表中（例如 wp_term_relationships）统计每个术语的文章数量。
• 只更新 taxonomy 为指定值，并且 term_id 在 $terms 数组中的术语。

_wp_term_recount_get_table() 函数

这个函数的作用是根据分类名称和对象类型，获取关联表的表名。

function _wp_term_recount_get_table( $taxonomy, $object_type ) {
  global $wpdb;

  if ( 'post' === $object_type ) {
    return $wpdb->term_relationships;
  }

  /**
   * Filters the table to use for term recounting.
   *
   * @since 5.1.0
   *
   * @param string|false $table       Table to use for recounting, false if none.
   * @param string       $taxonomy    Taxonomy being updated.
   * @param string       $object_type Object type being updated.
   */
  return apply_filters( 'term_recount_table', false, $taxonomy, $object_type );
}

如果对象类型是 post，则返回 wp_term_relationships 表。否则，使用 apply_filters( 'term_recount_table' ) 钩子，允许开发者自定义关联表的表名。

第四部分：wp_update_term() 如何触发计数更新？

wp_update_term() 函数本身并不直接调用 wp_update_term_count() 函数。但是，一些其他的 WordPress 函数或钩子可能会在 wp_update_term() 函数执行后，触发计数更新。例如：

• edited_term 钩子： 这个钩子会在术语更新后被触发。开发者可以在这个钩子上注册一个函数，调用 wp_update_term_count() 函数，更新术语的计数。
• created_term 钩子: 与 edited_term类似, 但是在创建术语后触发。
• 手动调用： 你也可以在自己的代码中手动调用 wp_update_term_count() 函数，更新术语的计数。

举例说明：

假设你有一个自定义的函数，用于更新术语的计数：

function my_update_term_count( $term_id, $tt_id, $taxonomy ) {
  wp_update_term_count( array( $term_id ), $taxonomy );
}
add_action( 'edited_term', 'my_update_term_count', 10, 3 );

这段代码会在每次术语更新后，调用 my_update_term_count() 函数，然后 my_update_term_count() 函数会调用 wp_update_term_count() 函数，更新术语的计数。

第五部分：注意事项和最佳实践

• 谨慎使用： wp_update_term() 函数会直接修改数据库，因此在使用时需要谨慎。
• 数据清理： 在更新术语信息之前，一定要对数据进行清理，防止恶意代码注入。
• 缓存清理： 更新术语信息后，一定要清理缓存，确保下次获取术语信息时，能够获取到最新的数据。
• 计数更新： 确保在适当的时候更新术语的计数，以保证数据的准确性。
• 性能优化： 如果需要批量更新术语信息，可以考虑使用批量更新的方法，减少数据库查询的次数，提高性能。

第六部分：总结

wp_update_term() 函数是 WordPress 中一个重要的函数，负责更新分类术语的信息。虽然它本身并不直接更新术语的计数，但是它的更新操作可能会间接影响到术语的计数。wp_update_term_count() 函数才是真正负责更新分类术语计数的“大力士”。

理解 wp_update_term() 和 wp_update_term_count() 函数的原理，可以帮助你更好地管理 WordPress 中的分类术语，提高网站的性能和用户体验。

表格总结：

函数名	作用	是否直接更新计数	触发计数更新的方式
wp_update_term()	更新分类术语的信息（名称、别名、描述、父级分类等）	否	间接影响，例如通过 edited_term 钩子触发 wp_update_term_count() 函数
wp_update_term_count()	更新分类术语的计数	是	直接调用，或者被其他函数/钩子调用
_wp_term_recount_get_table()	根据分类名称和对象类型，获取关联表的表名	否	被 wp_update_term_count() 函数调用

希望今天的讲解能够帮助大家更好地理解 wp_update_term() 函数的工作原理。咱们下期再见！