剖析 WordPress `get_posts()` 函数的源码：如何通过 `wp_get_post_revisions()` 获取文章修订版本。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress 中的时间旅行：`get_posts()` 和 `wp_get_post_revisions()` 讲座

大家好，我是今天的“时间旅行”导游。别害怕，我们不是真的要造时光机，而是要探索 WordPress 源码中关于文章修订版本的奥秘。主要工具是 get_posts() 和 wp_get_post_revisions() 这两个函数。

准备好了吗？让我们一起深入 WordPress 的内部，看看如何通过代码来实现文章的“时光倒流”。

第一站：`get_posts()` 的基本用法与“时空限制”

get_posts() 就像一个多功能的搜索工具，可以根据各种条件获取文章。它比 WP_Query 简单一些，更适合快速检索数据。

先看一个简单的例子：

<?php
$args = array(
    'posts_per_page' => 5,
    'category_name'  => 'news',
    'orderby'        => 'date',
    'order'          => 'DESC',
);

$posts = get_posts( $args );

if ( $posts ) {
    foreach ( $posts as $post ) {
        setup_postdata( $post );
        echo '<h2><a href="' . get_permalink() . '">' . get_the_title() . '</a></h2>';
        echo '<p>' . get_the_excerpt() . '</p>';
        wp_reset_postdata();
    }
} else {
    echo 'No posts found.';
}
?>

这段代码获取 news 分类下的 5 篇文章，按日期降序排列，并显示标题和摘要。 get_posts() 的参数非常丰富，可以根据 post_type、post_status、date_query 等等进行过滤。具体参数可以参考 WordPress 官方文档。

但要注意，默认情况下，get_posts() 不会返回文章的修订版本。它只返回当前发布的文章。想要获取修订版本，我们需要用到另外一个函数：wp_get_post_revisions()。

第二站：`wp_get_post_revisions()`：进入修订版本的平行宇宙

wp_get_post_revisions() 函数专门用于获取指定文章的修订版本。它的主要参数是文章的 ID。

<?php
$post_id = 123; // 替换为你要获取修订版本的文章 ID
$revisions = wp_get_post_revisions( $post_id );

if ( $revisions ) {
    echo '<ul>';
    foreach ( $revisions as $revision ) {
        echo '<li>';
        echo '<a href="' . get_permalink( $revision->ID ) . '">';
        echo 'Revision ID: ' . $revision->ID . ', Date: ' . get_the_date( '', $revision->ID );
        echo '</a>';
        echo '</li>';
    }
    echo '</ul>';
} else {
    echo 'No revisions found for this post.';
}
?>

这段代码会获取 ID 为 123 的文章的所有修订版本，并以列表的形式显示修订版本的 ID 和日期。

注意： wp_get_post_revisions() 返回的是一个对象数组，每个对象代表一个修订版本。我们可以像访问普通文章对象一样访问修订版本对象的属性，例如 $revision->post_title、$revision->post_content 等。

第三站：`get_posts()` 与 `wp_get_post_revisions()` 的“联姻”：获取包含修订版本的文章列表

现在，我们要将 get_posts() 和 wp_get_post_revisions() 结合起来，实现一个更复杂的需求：获取所有文章，并且包含它们的修订版本。

这稍微有点 tricky，因为 get_posts() 默认不返回修订版本，而 wp_get_post_revisions() 又需要文章 ID 才能获取修订版本。我们需要分两步走：

使用 get_posts() 获取所有文章（但不包含修订版本）。
循环遍历文章列表，对每一篇文章使用 wp_get_post_revisions() 获取其修订版本。

代码如下：

<?php
$args = array(
    'posts_per_page' => -1, // 获取所有文章
    'post_type'      => 'post', // 只获取 post 类型的文章，可以根据需要修改
    'post_status'    => 'any', // 获取所有状态的文章，包括 published, draft, pending 等
);

$posts = get_posts( $args );

if ( $posts ) {
    foreach ( $posts as $post ) {
        setup_postdata( $post );
        echo '<h2><a href="' . get_permalink() . '">' . get_the_title() . '</a></h2>';
        echo '<p>Post ID: ' . $post->ID . '</p>';

        // 获取修订版本
        $revisions = wp_get_post_revisions( $post->ID );

        if ( $revisions ) {
            echo '<h3>Revisions:</h3>';
            echo '<ul>';
            foreach ( $revisions as $revision ) {
                echo '<li>';
                echo '<a href="' . get_permalink( $revision->ID ) . '">';
                echo 'Revision ID: ' . $revision->ID . ', Date: ' . get_the_date( '', $revision->ID );
                echo '</a>';
                echo '</li>';
            }
            echo '</ul>';
        } else {
            echo '<p>No revisions found for this post.</p>';
        }

        wp_reset_postdata();
    }
} else {
    echo 'No posts found.';
}
?>

这段代码首先使用 get_posts() 获取所有 post 类型的文章。然后，对于每一篇文章，它都调用 wp_get_post_revisions() 获取其修订版本，并显示出来。

关键点：

posts_per_page 设置为 -1 表示获取所有文章。
post_status 设置为 any 表示获取所有状态的文章。
循环遍历文章列表，并对每一篇文章调用 wp_get_post_revisions()。

第四站：深入 `wp_get_post_revisions()` 的源码：时间旅行的幕后推手

让我们稍微深入一下 wp_get_post_revisions() 的源码，看看它是如何工作的。（这里只展示关键部分，完整代码请参考 WordPress 源码）

function wp_get_post_revisions( $post, $args = null ) {
    $post = get_post( $post );

    if ( ! $post ) {
        return false;
    }

    $defaults = array(
        'orderby' => 'date ID',
        'order'   => 'DESC',
        'posts_per_page' => -1,
        'check_enabled'  => true, // Check if revisions are enabled for this post type
    );

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

    if ( $args['check_enabled'] && ! wp_revisions_enabled( $post ) ) {
        return array();
    }

    $query_args = array(
        'post_type'      => 'revision',
        'posts_per_page' => $args['posts_per_page'],
        'orderby'        => $args['orderby'],
        'order'          => $args['order'],
        'post_parent'    => $post->ID,
        'post_status'    => 'any',
        'fields'         => '*',
    );

    // Filter the query args for revisions
    $query_args = apply_filters( 'wp_get_post_revisions_args', $query_args, $post, $args );

    $revisions = get_posts( $query_args );

    // Filter the revisions themselves
    $revisions = apply_filters( 'wp_get_post_revisions', $revisions, $post, $args );

    return $revisions;
}

代码分解：

获取文章对象： $post = get_post( $post ); 确保传入的参数是一个有效的文章对象。
设置默认参数： $defaults 定义了排序方式、数量限制等默认参数。
检查是否启用修订版本： wp_revisions_enabled( $post ) 检查当前文章类型是否启用了修订版本功能。
构建查询参数： $query_args 定义了用于获取修订版本的查询参数。关键参数包括 post_type（设置为 revision）、post_parent（设置为当前文章的 ID）和 post_status（设置为 any）。
使用 get_posts() 获取修订版本： $revisions = get_posts( $query_args ); 最终，wp_get_post_revisions() 也是通过 get_posts() 函数来获取修订版本的。只不过它传入了特定的查询参数，将 get_posts() 的搜索范围限定在指定文章的修订版本上。
应用过滤器： apply_filters() 允许开发者修改查询参数和修订版本列表。

核心思想：

wp_get_post_revisions() 本质上是对 get_posts() 的一个封装，它预设了一些参数，专门用于获取文章的修订版本。

第五站：优化与扩展：让时间旅行更高效

上面的代码虽然能实现获取文章及其修订版本的功能，但效率可能不高。特别是当文章数量很多时，循环调用 wp_get_post_revisions() 会导致大量的数据库查询。

优化策略：

缓存： 可以使用 WordPress 的对象缓存 API (wp_cache_get(), wp_cache_set()) 缓存 wp_get_post_revisions() 的结果，避免重复查询。
自定义 SQL 查询： 如果性能要求很高，可以考虑编写自定义 SQL 查询，一次性获取所有文章及其修订版本。这需要对 WordPress 的数据库结构有深入的了解。
使用 WP-CLI： 如果只是需要批量导出文章及其修订版本，可以使用 WP-CLI 工具。 WP-CLI 提供了 wp post list 和 wp post get 命令，可以方便地获取文章及其修订版本。

扩展方向：

版本比较： 可以实现一个版本比较功能，让用户可以查看不同修订版本之间的差异。这需要用到文本比较算法。
版本回滚： 可以实现一个版本回滚功能，让用户可以将文章恢复到之前的某个修订版本。这需要更新文章的内容和元数据。
用户界面： 可以将这些功能集成到 WordPress 后台，提供一个友好的用户界面。

结语：时间旅行的意义

通过今天的“时间旅行”，我们了解了 WordPress 中文章修订版本的获取方式。 get_posts() 和 wp_get_post_revisions() 这两个函数是实现这个功能的关键。

文章修订版本功能非常重要，它可以帮助我们：

防止意外丢失： 在编辑文章时，即使不小心删除了内容，也可以通过修订版本恢复。
记录修改历史： 可以查看文章的修改历史，了解文章是如何一步步演变的。
协作编辑： 在多人协作编辑文章时，可以追踪每个人的修改，方便进行版本控制。

希望今天的讲座能帮助你更好地理解 WordPress 的内部机制，并能将这些知识应用到实际开发中。谢谢大家！

补充表格：常用参数对比

参数名称	`get_posts()`	`wp_get_post_revisions()`	说明
`posts_per_page`	控制返回的文章数量。`-1` 表示所有文章。	控制返回的修订版本数量。`-1` 表示所有修订版本。	用于控制返回的文章或修订版本的数量。
`post_type`	指定文章类型，例如 `post`、`page`、`custom_post_type`。	默认为 `revision`，不需要手动指定。	用于指定要获取的文章类型。`wp_get_post_revisions()` 只获取修订版本，所以默认为 `revision`。
`post_status`	指定文章状态，例如 `publish`、`draft`、`pending`、`any`。	默认为 `any`，不需要手动指定。	用于指定要获取的文章状态。`wp_get_post_revisions()` 获取所有状态的修订版本，所以默认为 `any`。
`orderby`	指定排序方式，例如 `date`、`title`、`ID`。	默认为 `date ID`，可以修改。	用于指定排序方式。
`order`	指定排序顺序，例如 `ASC`（升序）、`DESC`（降序）。	默认为 `DESC`，可以修改。	用于指定排序顺序。
`category_name`	指定分类名称，用于筛选特定分类下的文章。	不适用。	`wp_get_post_revisions()` 用于获取指定文章的修订版本，与分类无关。
`post_parent`	不适用（通常用于 `get_children()` 函数）。	自动设置为当前文章的 ID。	`wp_get_post_revisions()` 会自动将 `post_parent` 设置为当前文章的 ID，用于筛选该文章的修订版本。
N/A	N/A	`check_enabled`	(boolean) 是否检查文章类型是否启用了修订版本功能。默认为 `true`。

WordPress 中的时间旅行：get_posts() 和 wp_get_post_revisions() 讲座

第一站：get_posts() 的基本用法与“时空限制”

第二站：wp_get_post_revisions()：进入修订版本的平行宇宙

第三站：get_posts() 与 wp_get_post_revisions() 的“联姻”：获取包含修订版本的文章列表

第四站：深入 wp_get_post_revisions() 的源码：时间旅行的幕后推手