发布于 由admin

详解 WordPress `get_posts()` 函数源码：`WP_Query` 类的参数传递与数组返回机制。

大家好，我是老码，今天咱们来聊聊 WordPress 里面的 get_posts() 函数，这玩意儿看似简单，实则内藏玄机，它背后隐藏着 WP_Query 类的强大力量，以及 WordPress 如何巧妙地将数据库查询结果转换成 PHP 数组的奥秘。准备好，咱们要开始一场源码探险之旅了！

第一站：get_posts() 的庐山真面目

首先，咱们先来扒一扒 get_posts() 函数的外衣，看看它到底干了些什么。简单来说，get_posts() 就是一个帮你从 WordPress 数据库里获取文章的便捷工具。它接受一个参数数组，根据这些参数去查询文章，然后把查询到的文章数据打包成一个数组返回给你。

它的基本用法是这样的：

<?php
$args = array(
    'numberposts' => 5, // 获取最近的 5 篇文章
    'category' => 1,   // 只获取分类 ID 为 1 的文章
    'orderby' => 'date', // 按照日期排序
    'order'   => 'DESC'  // 降序排列
);

$recent_posts = get_posts( $args );

if ( $recent_posts ) {
    echo '<ul>';
    foreach ( $recent_posts as $post ) {
        echo '<li><a href="' . get_permalink( $post->ID ) . '">' . $post->post_title . '</a></li>';
    }
    echo '</ul>';
}
?>

这段代码很容易理解，但关键在于 get_posts() 背后的实现。它并不是直接操作数据库，而是借助了 WordPress 的核心查询类：WP_Query。

第二站：WP_Query 的登场

WP_Query 类是 WordPress 用来执行文章查询的核心类。它负责构建复杂的 SQL 查询语句，从数据库获取数据，并将其转换成 WP_Post 对象。get_posts() 函数实际上就是 WP_Query 类的一个封装。

咱们来看看 get_posts() 函数的源码（路径：/wp-includes/post.php）：

function get_posts( $args = null ) {
    $defaults = array(
        'numberposts' => 5,
        'orderby' => 'post_date',
        'order' => 'DESC',
        'post_type' => 'post',
        'suppress_filters' => true,
    );

    $r = wp_parse_args( $args, $defaults );
    if ( empty( $r['post_status'] ) ) {
        $r['post_status'] = 'publish';
    }
    if ( ! empty( $r['numberposts'] ) && empty( $r['posts_per_page'] ) ) {
        $r['posts_per_page'] = $r['numberposts'];
    }

    if ( ! empty( $r['output'] ) && ( $r['output'] == OBJECT || $r['output'] == ARRAY_A || $r['output'] == ARRAY_N ) ) {
        $output = $r['output'];
        unset( $r['output'] );
    } else {
        $output = OBJECT;
    }

    if ( ! empty( $r['output_key'] ) ) {
        $output_key = $r['output_key'];
        unset( $r['output_key'] );
    } else {
        $output_key = 'ID';
    }

    $q = new WP_Query( $r );

    if ( ! $q->have_posts() ) {
        return array();
    }

    $posts = $q->posts;

    if ( $output == OBJECT ) {
        return $posts;
    } elseif ( $output == ARRAY_A ) {
        $return = array();
        foreach ( (array) $posts as $post ) {
            $return[ $post->$output_key ] = get_object_vars( $post );
        }
        return $return;
    } elseif ( $output == ARRAY_N ) {
        $return = array();
        foreach ( (array) $posts as $post ) {
            $return[ $post->$output_key ] = array_values( get_object_vars( $post ) );
        }
        return $return;
    }

    return $posts;
}

咱们来一行一行解读：

  1. $defaults: 定义了一组默认参数，比如默认获取 5 篇文章，按照日期降序排列等等。

  2. wp_parse_args( $args, $defaults ): 这个函数非常重要，它将你传入的参数 $args 和默认参数 $defaults 合并。如果你的 $args 中有和 $defaults 中相同的键，那么你的参数会覆盖默认参数。

  3. $r['post_status'] = 'publish': 确保默认情况下只获取已发布的文章。

  4. $q = new WP_Query( $r ): 这就是关键！创建一个 WP_Query 对象，并将合并后的参数 $r 传递给它。WP_Query 类会根据这些参数来构建 SQL 查询。

  5. if ( ! $q->have_posts() ): 如果查询结果为空，直接返回一个空数组。

  6. $posts = $q->posts: WP_Query 对象执行查询后，会将结果存储在 $q->posts 属性中。这个属性是一个包含 WP_Post 对象的数组。

  7. $output: 这个变量决定了 get_posts() 函数返回数据的格式。默认是 OBJECT，也就是返回一个包含 WP_Post 对象的数组。你也可以将其设置为 ARRAY_A (关联数组) 或 ARRAY_N (索引数组)。

  8. $output_key: 这个变量决定了返回数组的键名，默认是文章的ID。

  9. return $posts: 最后，函数根据 $output 的值，将 $posts 数组转换成不同的格式并返回。

第三站：参数传递的艺术

get_posts() 函数接收的参数数组，最终都会传递给 WP_Query 类。这意味着你可以使用 WP_Query 类支持的所有参数来控制文章的查询。

下面是一些常用的参数：

参数名 描述 示例
numberposts 获取的文章数量。 'numberposts' => 10
posts_per_page 每页显示的文章数量。这个参数会影响分页。 'posts_per_page' => 5
category 获取指定分类的文章。可以使用分类 ID。 'category' => 1
category_name 获取指定分类的文章。可以使用分类别名 (slug)。 'category_name' => 'news'
tag 获取指定标签的文章。可以使用标签别名 (slug)。 'tag' => 'featured'
tag_id 获取指定标签的文章。可以使用标签 ID。 'tag_id' => 5
author 获取指定作者的文章。可以使用作者 ID。 'author' => 1
author_name 获取指定作者的文章。可以使用作者的用户名 (nicename)。 'author_name' => 'john'
post_type 获取指定文章类型的文章。默认为 post。 'post_type' => 'page'
post_status 获取指定状态的文章。默认为 publish。 'post_status' => 'draft'
orderby 排序方式。常用的有 date (日期), title (标题), rand (随机) 等。 'orderby' => 'title'
order 排序顺序。ASC (升序) 或 DESC (降序)。 'order' => 'ASC'
s 搜索关键词。 's' => 'WordPress'
date_query 日期查询。可以使用复杂的日期条件。 见下面的日期查询示例
meta_key 自定义字段的键名。 'meta_key' => 'my_custom_field'
meta_value 自定义字段的值。 'meta_value' => 'some_value'
meta_query 自定义字段查询。可以使用复杂的自定义字段条件。 见下面的自定义字段查询示例
tax_query 分类和标签查询。可以使用复杂的分类和标签条件。 见下面的分类和标签查询示例
p 根据post id 获取指定的文章 'p' => 123

日期查询示例：

$args = array(
    'date_query' => array(
        array(
            'year'  => 2023,
            'month' => 10,
        ),
    ),
);
$posts = get_posts( $args ); // 获取 2023 年 10 月的所有文章

自定义字段查询示例：

$args = array(
    'meta_query' => array(
        array(
            'key'     => 'color',
            'value'   => 'red',
            'compare' => '=',
        ),
    ),
);
$posts = get_posts( $args ); // 获取自定义字段 'color' 的值为 'red' 的所有文章

分类和标签查询示例：

$args = array(
    'tax_query' => array(
        'relation' => 'AND', // 可以是 AND 或 OR
        array(
            'taxonomy' => 'category',
            'field'    => 'slug',
            'terms'    => array( 'news', 'updates' ),
        ),
        array(
            'taxonomy' => 'post_tag',
            'field'    => 'id',
            'terms'    => array( 10, 12 ),
        ),
    ),
);
$posts = get_posts( $args ); // 获取同时属于 'news' 或 'updates' 分类，并且包含标签 ID 为 10 或 12 的文章

第四站：WP_Post 对象与数据转换

当 WP_Query 类从数据库获取到文章数据后，它会将每一篇文章的数据封装成一个 WP_Post 对象。WP_Post 对象包含了文章的所有信息，比如标题、内容、作者、日期等等。

你可以通过访问 WP_Post 对象的属性来获取文章的信息：

<?php
$args = array(
    'numberposts' => 1,
);
$posts = get_posts( $args );

if ( $posts ) {
    $post = $posts[0]; // 获取第一篇文章

    echo '文章标题：' . $post->post_title . '<br>';
    echo '文章内容：' . $post->post_content . '<br>';
    echo '文章作者 ID：' . $post->post_author . '<br>';
    echo '文章发布日期：' . $post->post_date . '<br>';
}
?>

如果你在 get_posts() 函数中设置了 $output 参数为 ARRAY_A 或 ARRAY_N，那么 WP_Post 对象会被转换成数组。

  • ARRAY_A (关联数组)：WP_Post 对象的属性会变成数组的键，属性值会变成数组的值。
  • ARRAY_N (索引数组)：WP_Post 对象的属性值会按照一定的顺序排列在数组中，你可以通过索引来访问这些值。

例子：ARRAY_A 的效果

<?php
$args = array(
    'numberposts' => 1,
    'output' => ARRAY_A,
);
$posts = get_posts( $args );

if ( $posts ) {
    $post = $posts[ key($posts) ]; // 获取第一篇文章, key($posts) 获取第一个元素的键名

    echo '文章标题：' . $post['post_title'] . '<br>';
    echo '文章内容：' . $post['post_content'] . '<br>';
    echo '文章作者 ID：' . $post['post_author'] . '<br>';
    echo '文章发布日期：' . $post['post_date'] . '<br>';
}
?>

例子： 指定output_key 的效果

<?php
$args = array(
    'numberposts' => 2,
    'output' => ARRAY_A,
    'output_key' => 'post_name',
);
$posts = get_posts( $args );

if ( $posts ) {
    foreach ($posts as $post_name => $post) {
        echo '文章别名：' . $post_name . '<br>'; // 文章别名作为键
        echo '文章标题：' . $post['post_title'] . '<br>'; // 通过键访问文章标题
    }
}
?>

第五站：WP_Query 类的核心方法

要理解 WP_Query 类的工作原理，需要了解它的一些核心方法。

方法名 描述
__construct() 构造函数。接收参数数组，并根据参数来初始化查询。
query() 执行查询。这个方法会根据参数构建 SQL 查询语句，并从数据库获取数据。
get_posts() 从数据库获取文章数据。这个方法会使用 $wpdb 对象来执行 SQL 查询。
parse_query() 解析查询参数。这个方法会将传入的参数转换成 SQL 查询语句可以理解的形式。
get_posts() 根据 $query 属性中定义的参数，执行数据库查询并填充 $posts 属性。这是获取文章数据的主要方法。
have_posts() 检查是否还有文章可以循环。
the_post() 将全局 $post 变量设置为当前文章。这个方法通常在循环中使用。
rewind_posts() 重置文章循环。这个方法会将文章指针重置到第一篇文章。

第六站：性能优化小技巧

虽然 get_posts() 函数很方便，但是如果不注意，可能会影响网站的性能。以下是一些优化技巧：

  1. 限制文章数量：使用 numberposts 或 posts_per_page 参数来限制获取的文章数量。不要一次性获取所有文章。

  2. 指定需要的字段：尽量只获取需要的字段，避免获取所有字段。这可以通过自定义 SQL 查询来实现，但对于 get_posts() 来说不太适用。

  3. 使用缓存：对于经常访问的数据，可以使用 WordPress 的缓存 API 来缓存查询结果。

  4. 避免复杂的查询：复杂的查询会增加数据库的负担。尽量简化查询条件，或者使用自定义 SQL 查询来优化性能。

  5. 索引优化：确保数据库表上的相关字段已经建立了索引，这可以加快查询速度。

第七站：总结与展望

通过今天的源码探险，我们深入了解了 get_posts() 函数的内部机制，以及它与 WP_Query 类之间的关系。我们还学习了如何使用不同的参数来控制文章的查询，以及如何将查询结果转换成不同的数据格式。

get_posts() 函数是 WordPress 开发中非常常用的工具，掌握它的原理和用法，可以帮助你更好地构建 WordPress 网站。

当然，WP_Query 类的功能远不止于此。它还支持分页、自定义查询等等。如果你想更深入地了解 WP_Query 类，可以参考 WordPress 官方文档，或者继续深入研究它的源码。

好了，今天的讲座就到这里。希望大家有所收获！下次有机会，咱们再一起探索 WordPress 的其他奥秘。

发表回复

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