发布于 由admin

解析 WordPress `get_adjacent_post()` 函数的源码：如何查询相邻文章的 ID，并解释其性能。

WordPress get_adjacent_post() 函数源码解析：相邻文章的秘密与性能考量

嘿，各位代码爱好者！今天咱们来聊聊 WordPress 中一个看似简单却暗藏玄机的函数：get_adjacent_post()。 别看它名字平平无奇，功能也就是获取相邻文章，但要真正理解它的运作方式，可得扒开源码，看看它到底在玩什么花样。

想象一下，你正在浏览一篇精彩的文章，读完后想看看上一篇或下一篇，这时 get_adjacent_post() 就派上用场了。它能帮你找到与当前文章相关的相邻文章，方便用户继续阅读。

get_adjacent_post() 的基本用法

在开始深入源码之前，先回顾一下 get_adjacent_post() 的基本用法。它接受三个参数：

get_adjacent_post( bool $in_same_term = false, string $excluded_terms = '', bool $previous = true, string $taxonomy = 'category' ) : WP_Post|null
  • $in_same_term： (可选) 是否在同一分类法 (taxonomy) 术语 (term) 中查找相邻文章。 默认为 false。
  • $excluded_terms： (可选) 要排除的术语的字符串或数组。
  • $previous： (可选) 是否查找上一篇文章。 如果为 true，则查找上一篇文章；如果为 false，则查找下一篇文章。 默认为 true。
  • $taxonomy： (可选) 要使用的分类法名称。 默认为 'category'。

使用示例：

// 获取上一篇文章，不考虑分类
$previous_post = get_adjacent_post( false, '', true );

// 获取同一分类下的下一篇文章
$next_post = get_adjacent_post( true, '', false );

// 获取同一标签下，排除 'featured' 标签的上一篇文章
$previous_post_excluded = get_adjacent_post( true, 'featured', true, 'post_tag' );

源码剖析：一步一步揭开神秘面纱

现在，让我们深入到 WordPress 的核心代码中，看看 get_adjacent_post() 到底是如何工作的。 以下是经过简化和注释的关键代码片段（基于 WordPress 6.4.3）：

function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
    global $post;

    if ( ! is_singular() ) {
        return null; // 只有在单篇文章页面才能使用
    }

    $post = get_post( $post ); // 确保 $post 是一个 WP_Post 对象

    if ( ! is_object( $post ) ) {
        return null; // 如果文章不存在，则返回 null
    }

    $current_post_date = $post->post_date; // 获取当前文章的发布日期

    $join = '';
    $where = '';
    $op = $previous ? '<' : '>'; // 根据 $previous 决定是查找之前还是之后的文章
    $order = $previous ? 'DESC' : 'ASC'; // 相应的排序方式

    if ( $in_same_term && $taxonomy ) { // 如果需要在同一分类法下查找
        $term_ids = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); // 获取当前文章的分类法术语 ID

        if ( ! empty( $term_ids ) && ! is_wp_error( $term_ids ) ) {
            $term_ids = array_map( 'intval', $term_ids ); // 确保 ID 是整数

            $join = "INNER JOIN wp_term_relationships AS tr ON p.ID = tr.object_id INNER JOIN wp_term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id"; // 添加 JOIN 子句
            $where = 'AND tt.taxonomy = '' . esc_sql( $taxonomy ) . '' AND tt.term_id IN (' . implode( ',', $term_ids ) . ')'; // 添加 WHERE 子句，限制在同一分类法术语下
        }
    }

    if ( $excluded_terms ) { // 如果有需要排除的术语
        if ( is_array( $excluded_terms ) ) {
            $excluded_terms = implode( ',', array_map( 'intval', $excluded_terms ) ); // 确保 ID 是整数，并转换为字符串
        }

        if ( ! empty( $excluded_terms ) ) {
            $join .= " INNER JOIN wp_term_relationships AS tr2 ON p.ID = tr2.object_id INNER JOIN wp_term_taxonomy AS tt2 ON tr2.term_taxonomy_id = tt2.term_taxonomy_id"; // 添加 JOIN 子句
            $where .= ' AND tt2.term_id NOT IN (' . esc_sql( $excluded_terms ) . ')'; // 添加 WHERE 子句，排除指定术语
        }
    }

    $where .= " AND p.post_type = '" . esc_sql( $post->post_type ) . "'"; // 确保文章类型相同
    $where .= " AND p.post_status = 'publish'"; // 确保文章已发布

    // 构建 SQL 查询语句
    $query = "SELECT p.ID FROM wp_posts AS p $join WHERE p.post_date $op '$current_post_date' $where ORDER BY p.post_date $order LIMIT 1";

    $adjacent_id = $wpdb->get_var( $query ); // 执行查询，获取相邻文章的 ID

    if ( $adjacent_id ) {
        return get_post( $adjacent_id ); // 根据 ID 获取 WP_Post 对象
    } else {
        return null; // 如果没有找到相邻文章，则返回 null
    }
}

代码流程解析：

  1. 参数检查和初始化：

    • 首先，函数检查当前是否在单篇文章页面。如果不是，则直接返回 null。
    • 然后，它确保 $post 变量是一个 WP_Post 对象，并获取当前文章的发布日期 $current_post_date。

  2. 构建 SQL 查询：

    • 根据 $previous 参数，确定是查找上一篇 (<) 还是下一篇 (>) 文章，以及相应的排序方式 (DESC 或 ASC)。
    • 如果 $in_same_term 为 true，则添加 JOIN 和 WHERE 子句，以限制在同一分类法术语下查找。 这里使用 wp_get_object_terms 获取当前文章的分类法术语 ID。
    • 如果有 $excluded_terms，则添加额外的 JOIN 和 WHERE 子句，以排除指定的术语。
    • 确保文章类型和状态与当前文章相同。

  3. 执行查询并返回结果：

    • 使用 $wpdb->get_var() 执行 SQL 查询，获取相邻文章的 ID。
    • 如果找到了相邻文章的 ID，则使用 get_post() 函数获取对应的 WP_Post 对象并返回。
    • 如果没有找到，则返回 null。

关键点总结：

  • get_adjacent_post() 的核心在于构建一个 SQL 查询语句，该语句根据传入的参数动态地调整 JOIN 和 WHERE 子句。
  • 它使用 wp_get_object_terms() 函数获取当前文章的分类法术语 ID。
  • 它使用 $wpdb->get_var() 函数执行查询，这是一个直接查询数据库的方法。
  • 它最终返回的是一个 WP_Post 对象，而不是文章 ID。

性能考量：如何优化相邻文章的查询

虽然 get_adjacent_post() 功能强大，但在某些情况下，它的性能可能会成为瓶颈。 特别是在大型网站上，当需要在同一分类法下查找相邻文章时，SQL 查询可能会变得非常复杂，导致查询速度变慢。

性能瓶颈分析：

  1. SQL 查询复杂度：

    • 当 $in_same_term 为 true 时，需要执行 JOIN 操作，这会增加 SQL 查询的复杂度。
    • 如果 $excluded_terms 包含多个术语，WHERE 子句中的 NOT IN 操作也会影响性能。

  2. 数据库查询：

    • 每次调用 get_adjacent_post() 都会执行一次数据库查询，这会增加数据库的负载。

优化策略：

  1. 减少数据库查询：

    • 尽可能缓存 get_adjacent_post() 的结果。可以使用 WordPress 的 transient API 或其他缓存机制来存储查询结果。
    • 如果需要在多个地方使用相邻文章的信息，可以只调用一次 get_adjacent_post()，并将结果存储在变量中。

  2. 优化 SQL 查询：

    • 确保数据库表上的索引是正确的。 特别是 wp_term_relationships 表和 wp_term_taxonomy 表上的索引。
    • 避免使用过多的 $excluded_terms。 如果需要排除大量的术语，可以考虑使用其他方法来实现。
    • 自定义 SQL 查询。 如果默认的 get_adjacent_post() 函数无法满足需求，可以编写自定义的 SQL 查询，以获得更好的性能。

  3. 考虑使用插件：

    • 有一些 WordPress 插件专门用于优化相邻文章的查询。 这些插件通常使用更高效的算法和缓存机制来提高性能。

示例代码：使用 Transient API 缓存 get_adjacent_post() 的结果

function get_cached_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
    global $post;

    $cache_key = 'adjacent_post_' . $post->ID . '_' . md5( serialize( func_get_args() ) ); // 创建一个唯一的缓存键

    $cached_post = get_transient( $cache_key ); // 尝试从缓存中获取结果

    if ( false === $cached_post ) { // 如果缓存中没有结果
        $cached_post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy ); // 调用原始函数获取结果

        set_transient( $cache_key, $cached_post, HOUR_IN_SECONDS ); // 将结果缓存一个小时
    }

    return $cached_post; // 返回结果
}

// 使用缓存的版本
$previous_post = get_cached_adjacent_post( true, '', true );

表格总结性能优化策略：

优化策略 描述 适用场景
减少数据库查询 使用 Transient API 或其他缓存机制缓存 get_adjacent_post() 的结果。 所有场景，特别是当相邻文章的信息被频繁使用时。
优化 SQL 查询 确保数据库表上的索引是正确的。 避免使用过多的 $excluded_terms。 自定义 SQL 查询，以获得更好的性能。 当 $in_same_term 为 true，且 $excluded_terms 包含大量术语时。
使用插件 使用专门用于优化相邻文章查询的插件。 当需要更高级的优化策略，或者不想手动编写代码时。

总结：get_adjacent_post() 的智慧与挑战

get_adjacent_post() 是一个方便实用的 WordPress 函数，它可以帮助你轻松地获取相邻文章的信息。 但是，在实际使用中，需要注意其性能问题，并根据具体情况选择合适的优化策略。

理解 get_adjacent_post() 的源码，不仅可以帮助你更好地使用它，还可以让你更深入地了解 WordPress 的底层机制。 希望今天的讲座能帮助你更好地掌握这个函数，并在你的 WordPress 项目中发挥它的作用！

记住，代码的世界充满了乐趣和挑战，不断学习和探索才能成为真正的编程大师！ 下次再见！

发表回复

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