分析 WordPress `get_posts()` 函数的源码：它是如何作为 `WP_Query` 的一个简化封装的。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位同学，早上好！今天咱们来聊聊 WordPress 里面一个经常被用到的函数 get_posts()。别看它名字简单，背后可是藏着一个强大的引擎——WP_Query。 get_posts() 其实就是对 WP_Query 的一个简化封装，让咱们在写代码的时候更省心。接下来，我们就一层一层地扒开它的源码，看看它是怎么工作的。

1. get_posts() 的基本用法和目的

在开始深入源码之前，先简单回顾一下 get_posts() 的用法。假设我们需要获取最新的 5 篇文章，我们可以这样写：

<?php
$args = array(
    'posts_per_page' => 5,
    'orderby'        => 'date',
    'order'          => 'DESC',
);
$recent_posts = get_posts( $args );
foreach ( $recent_posts as $post ) : setup_postdata( $post ); ?>
    <li>
        <a href="<?php the_permalink(); ?>"><?php the_title(); ?></a>
    </li>
<?php endforeach;
wp_reset_postdata();
?>

这段代码会返回一个包含 5 篇文章对象的数组。它的目的就是：以最简洁的方式，根据给定的参数，获取符合条件的文章列表。 避免了直接使用 WP_Query 时需要写的额外代码，比如实例化对象等等。

2. 源码剖析：从入口开始

让我们直接跳到 WordPress 源码，找到 get_posts() 的定义。（通常在 wp-includes/post.php 文件中）。你将会看到类似这样的代码：

function get_posts( $args = null ) {
    $defaults = array(
        'numberposts'      => 5,
        'category'         => 0,
        'orderby'          => 'date',
        'order'            => 'DESC',
        'include'          => array(),
        'exclude'          => array(),
        'meta_key'         => '',
        'meta_value'       => '',
        'post_type'        => 'post',
        'suppress_filters' => true,
    );

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

    // 处理 numberposts 的别名 posts_per_page
    if ( isset( $r['posts_per_page'] ) && ( -1 != $r['posts_per_page'] ) ) {
        $r['numberposts'] = $r['posts_per_page'];
    }

    if ( isset( $r['post_status'] ) && 'any' == $r['post_status'] ) {
        $r['post_status'] = null;
    }

    if ( ! empty( $r['numberposts'] ) && $r['numberposts'] < 0 ) {
        $r['numberposts'] = 0;
    }

    $get_posts = new WP_Query( $r );

    return $get_posts->posts;
}

别慌，我们来一步步解读这段代码：

默认参数： 首先，定义了一个 $defaults 数组，包含了 get_posts() 默认的参数。比如，默认获取 5 篇文章，按照日期倒序排列，文章类型是 post 等等。这些默认值保证了即使你不传递任何参数，get_posts() 也能正常工作。
参数解析： wp_parse_args( $args, $defaults ) 这个函数非常关键。它的作用是将你传递的参数 $args 和默认参数 $defaults 合并起来。如果 $args 中有和 $defaults 中相同的键，那么 $args 中的值会覆盖 $defaults 中的值。简单来说，就是你说了算，你没说的，就用默认的。
别名处理： posts_per_page 是 numberposts 的别名。这样做是为了兼容性，让开发者可以使用更直观的参数名。
实例化 WP_Query： $get_posts = new WP_Query( $r ); 这行代码是核心！它将合并后的参数数组 $r 传递给 WP_Query 类的构造函数，创建了一个 WP_Query 对象。也就是说，get_posts() 最终还是通过 WP_Query 来完成文章的查询。
返回结果： return $get_posts->posts; WP_Query 对象有一个 $posts 属性，它是一个包含查询结果的数组。 get_posts() 函数直接返回了这个 $posts 数组，方便我们直接使用。

3. WP_Query 才是幕后英雄

现在，我们知道了 get_posts() 只是 WP_Query 的一个简单入口。真正干活的是 WP_Query 类。 WP_Query 类负责：

解析查询参数
构建 SQL 查询语句
执行查询
将查询结果封装成文章对象

WP_Query 类非常复杂，包含大量的代码和逻辑。但我们可以简单地理解为：它是一个强大的数据库查询工具，专门用于获取 WordPress 的各种数据（文章、页面、分类等等）。

4. get_posts() 的优势和局限

优势：
- 简单易用： get_posts() 的参数比 WP_Query 少，使用起来更简单直接。
- 代码简洁： 避免了手动实例化 WP_Query 对象，减少了代码量。
- 默认设置： 提供了一组合理的默认参数，方便快速获取文章列表。
局限：
- 灵活性不足： get_posts() 封装了一些常用的参数，但如果你需要更高级的查询，比如使用复杂的 meta query，或者修改 SQL 语句，那么 get_posts() 就无能为力了。
- 性能问题： 在某些情况下，过度使用 get_posts() 可能会导致性能问题。因为每次调用 get_posts() 都会创建一个新的 WP_Query 对象。如果需要在循环中多次调用，建议使用 WP_Query 对象并复用。

5. 什么时候用 get_posts()，什么时候用 WP_Query？

这是一个非常重要的问题。总的来说，可以遵循以下原则：

简单查询： 如果只是需要获取简单的文章列表，比如最新的几篇文章，或者某个分类下的文章，那么 get_posts() 是一个不错的选择。
复杂查询： 如果需要进行复杂的查询，比如使用 meta query，或者需要对查询结果进行更精细的控制，那么应该使用 WP_Query。
性能考虑： 如果需要在循环中多次查询，或者对性能要求比较高，那么应该使用 WP_Query，并注意缓存查询结果。

为了更清晰地说明，可以参考下表：

功能特点	`get_posts()`	`WP_Query`
使用场景	简单文章列表查询	复杂文章列表查询，自定义 SQL 查询
代码量	较少	较多
灵活性	较低	较高
性能	适用于简单场景，循环中多次调用可能影响性能	可以优化查询，提高性能
参数数量	较少	较多
是否需要实例化	不需要	需要

6. 深入理解 WP_Query 的参数

虽然 get_posts() 简化了参数，但理解 WP_Query 的参数对于更好地使用 get_posts() 也是很有帮助的。以下是一些常用的 WP_Query 参数：

post_type： 指定文章类型。可以是 post、page、attachment，或者自定义文章类型。
posts_per_page： 每页显示的文章数量。设置为 -1 表示显示所有文章。
category_name： 指定分类的别名。
tag： 指定标签的别名。
orderby： 指定排序方式。可以是 date、title、rand 等等。
order： 指定排序顺序。可以是 ASC（升序）或 DESC（降序）。
meta_key 和 meta_value： 用于查询具有特定自定义字段的文章。
tax_query： 用于进行更复杂的分类法查询。
meta_query： 用于进行更复杂的自定义字段查询。

7. 代码示例：使用 WP_Query 实现更复杂的查询

假设我们需要查询所有 book 类型的文章，并且这些文章的 author 自定义字段的值为 John Doe。使用 get_posts() 无法直接实现，我们需要使用 WP_Query：

<?php
$args = array(
    'post_type'      => 'book',
    'posts_per_page' => -1,
    'meta_query'     => array(
        array(
            'key'   => 'author',
            'value' => 'John Doe',
        ),
    ),
);

$the_query = new WP_Query( $args );

if ( $the_query->have_posts() ) {
    echo '<ul>';
    while ( $the_query->have_posts() ) {
        $the_query->the_post();
        echo '<li><a href="' . get_permalink() . '">' . get_the_title() . '</a></li>';
    }
    echo '</ul>';
    wp_reset_postdata();
} else {
    echo 'No books found with author John Doe.';
}
?>

这段代码首先定义了一个 $args 数组，包含了 post_type、posts_per_page 和 meta_query 参数。 meta_query 是一个嵌套数组，用于指定自定义字段的查询条件。然后，我们创建了一个 WP_Query 对象 $the_query，并将 $args 传递给它。接下来，我们使用 while 循环遍历查询结果，并输出文章的标题和链接。最后，使用 wp_reset_postdata() 重置全局文章数据。

8. 总结

get_posts() 是 WP_Query 的一个简化封装，它提供了一种简单快捷的方式来获取文章列表。但是，WP_Query 才是真正的幕后英雄，它提供了更强大的查询功能和更灵活的控制。在选择使用哪个函数时，需要根据实际需求进行权衡。如果只是需要进行简单的查询，那么 get_posts() 是一个不错的选择。如果需要进行复杂的查询，或者对性能要求比较高，那么应该使用 WP_Query。

掌握 get_posts() 和 WP_Query 的用法，可以帮助你更好地控制 WordPress 的数据查询，提高代码的效率和可维护性。希望今天的讲座对大家有所帮助！下次有机会再和大家分享更多 WordPress 开发的技巧。谢谢大家！

发表回复 取消回复

发表回复取消回复