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

各位观众老爷，大家好！今天咱们来聊聊WordPress里面一个挺有意思的函数：wp_get_post_revisions()。这玩意儿就像文章的时光机，能带你回到过去，看看你文章都经历了哪些“整容”。

开场白：修订版的江湖地位

在WordPress的世界里，修订版就像是文章的“备忘录”。每次你保存或更新文章，WordPress都会偷偷摸摸地把旧版本存起来。这可不是为了让你怀旧，而是为了防止你手抖删错了东西，或者想回到某个灵光一闪的时刻。

wp_get_post_revisions()：时光机的钥匙

wp_get_post_revisions() 函数就是打开这扇“时光机”大门的钥匙。它能帮你把文章的所有修订版本都找出来，让你想回到哪个版本就回到哪个版本。

基本用法：简单粗暴，一键获取

最简单的用法就是直接把文章的ID传进去：

<?php
$revisions = wp_get_post_revisions( $post_id );

if ( $revisions ) {
  echo "<h3>文章修订历史：</h3>";
  echo "<ul>";
  foreach ( $revisions as $revision ) {
    echo '<li><a href="' . get_edit_post_link( $revision->ID ) . '">' . get_the_title( $revision->ID ) . ' (修订时间：' . get_the_modified_date( '', $revision->ID ) . ')</a></li>';
  }
  echo "</ul>";
} else {
  echo "<p>没有找到修订版本。</p>";
}
?>

这段代码会输出文章的修订历史，每个修订版本都有一个链接，可以让你直接编辑这个版本。

参数详解：定制你的时光之旅

wp_get_post_revisions() 函数其实还有一些参数，可以让你更精确地控制你想获取哪些修订版本。

参数	类型	默认值	说明
`$post_id`	int	required	文章的ID，必须提供。
`$args`	array	array()	一个数组，用于指定查询修订版本的各种参数。

$args 数组里面可以包含以下参数：

posts_per_page (int): 每页显示的修订版本数量。默认值为 -1，表示显示所有修订版本。
orderby (string): 排序方式。默认值为 ‘post_modified’，表示按修改时间排序。还可以设置为 ‘post_date’（按发布时间排序）或 ‘ID’（按ID排序）。
order (string): 排序顺序。默认值为 ‘DESC’，表示降序排列。还可以设置为 ‘ASC’，表示升序排列。
check_enabled (bool): 是否检查修订版本功能是否启用。默认值为 true。
fields (string): 返回哪些字段。默认值为 ”，表示返回所有字段。还可以设置为 ‘ids’（只返回ID）。

高级用法：玩转参数，定制查询

假设你想获取某个文章的最近5个修订版本，并按修改时间升序排列，可以这样写：

<?php
$args = array(
  'posts_per_page' => 5,
  'orderby'        => 'post_modified',
  'order'          => 'ASC'
);

$revisions = wp_get_post_revisions( $post_id, $args );

if ( $revisions ) {
  echo "<h3>文章最近5个修订版本（按修改时间升序排列）：</h3>";
  echo "<ul>";
  foreach ( $revisions as $revision ) {
    echo '<li><a href="' . get_edit_post_link( $revision->ID ) . '">' . get_the_title( $revision->ID ) . ' (修订时间：' . get_the_modified_date( '', $revision->ID ) . ')</a></li>';
  }
  echo "</ul>";
} else {
  echo "<p>没有找到修订版本。</p>";
}
?>

源码剖析：扒开它的皮，看看里面长啥样

为了更深入地了解 wp_get_post_revisions() 函数，咱们来扒开它的皮，看看里面的代码是怎么写的。

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

    if ( ! $post ) {
        return false;
    }

    $defaults = array(
        'posts_per_page' => -1,
        'orderby'        => 'post_modified',
        'order'          => 'DESC',
        'check_enabled'  => true,
        'fields'         => '',
    );

    $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,
        'fields'         => $args['fields'],
        'post_status'    => 'any',
    );

    /**
     * Filters the arguments passed to WP_Query in wp_get_post_revisions().
     *
     * @since 2.6.0
     *
     * @param array $query_args Array of WP_Query arguments.
     * @param array $args       Array of wp_get_post_revisions() arguments.
     */
    $query_args = apply_filters( 'wp_get_post_revisions_args', $query_args, $args );

    $revisions = new WP_Query( $query_args );

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

    $revision_ids = wp_list_pluck( $revisions->posts, 'ID' );

    /**
     * Filters the list of post revisions.
     *
     * @since 2.6.0
     *
     * @param WP_Post[] $posts Array of post revision objects.
     * @param array     $args  Array of wp_get_post_revisions() arguments.
     */
    $revisions = apply_filters( 'wp_get_post_revisions', $revisions->posts, $args );

    if ( 'ids' === $args['fields'] ) {
        return $revision_ids;
    }

    return $revisions;
}

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

获取文章对象： 首先，通过 get_post() 函数获取文章对象。如果文章不存在，就返回 false。
设置默认参数： 定义了一个默认参数数组，包含了 posts_per_page、orderby、order、check_enabled 和 fields 等参数的默认值。
合并参数： 使用 wp_parse_args() 函数将传入的参数和默认参数合并。
检查修订版本功能是否启用： 如果 $args['check_enabled'] 为 true，就通过 wp_revisions_enabled() 函数检查修订版本功能是否启用。如果没有启用，就返回一个空数组。
构建查询参数： 构建一个用于 WP_Query 的参数数组，包含了 post_type（设置为 ‘revision’）、posts_per_page、orderby、order、post_parent（设置为文章的ID）、fields 和 post_status 等参数。
应用过滤器 wp_get_post_revisions_args： 允许开发者通过这个过滤器修改传递给 WP_Query 的参数。
执行查询： 使用 WP_Query 类执行查询，获取修订版本。
判断是否有结果： 如果没有找到任何修订版本，就返回一个空数组。
提取修订版本ID： 使用 wp_list_pluck() 函数从 WP_Query 对象中提取修订版本的ID。
应用过滤器 wp_get_post_revisions： 允许开发者通过这个过滤器修改修订版本列表。
返回结果： 如果 $args['fields'] 设置为 ‘ids’，就返回修订版本的ID数组；否则，返回修订版本对象数组。

重点：WP_Query 的妙用

从源码可以看出，wp_get_post_revisions() 函数的核心是使用 WP_Query 类来查询修订版本。WP_Query 是 WordPress 中一个非常强大的类，可以用来查询各种类型的文章，包括文章、页面、自定义文章类型等等。

过滤器：灵活扩展，随心所欲

wp_get_post_revisions() 函数还提供了两个过滤器：

wp_get_post_revisions_args：用于修改传递给 WP_Query 的参数。
wp_get_post_revisions：用于修改修订版本列表。

这两个过滤器可以让你在不修改 wp_get_post_revisions() 函数源码的情况下，灵活地扩展它的功能。

实际应用：脑洞大开，无限可能

wp_get_post_revisions() 函数在实际应用中有很多可能性：

版本控制： 可以用来实现文章的版本控制功能，让用户可以方便地查看和恢复文章的历史版本。
内容对比： 可以用来实现文章内容对比功能，让用户可以清晰地看到文章在不同版本之间的差异。
数据分析： 可以用来分析文章的修改历史，了解文章的演变过程，为内容创作提供参考。
撤销功能： 可以实现自定义的撤销功能，例如撤销最近一次的修改。

注意事项：小细节，大学问

性能问题： 获取大量的修订版本可能会影响网站的性能，特别是对于大型网站。因此，在使用 wp_get_post_revisions() 函数时，要注意控制查询的范围，避免一次性获取太多的数据。
权限问题： 只有具有足够权限的用户才能查看文章的修订版本。因此，在使用 wp_get_post_revisions() 函数时，要注意检查用户的权限。
修订版本数量限制： WordPress 默认会限制每个文章的修订版本数量。可以通过 WP_POST_REVISIONS 常量来修改这个限制。

WP_POST_REVISIONS 常量：控制修订版本的数量

WordPress允许你使用 WP_POST_REVISIONS 常量来控制保存的修订版本数量。你可以在 wp-config.php 文件中定义这个常量。

true 或 -1: 保存所有修订版本。
false 或 0: 不保存任何修订版本（除了自动保存）。
int: 保存指定数量的修订版本。

例如，如果你只想保存最新的3个修订版本，可以这样设置：

define( 'WP_POST_REVISIONS', 3 );

自动保存：文章的守护神

除了手动保存的修订版本，WordPress还会自动保存文章。自动保存的频率可以通过 AUTOSAVE_INTERVAL 常量来设置，默认值为 60 秒。

define( 'AUTOSAVE_INTERVAL', 120 ); // 设置为120秒自动保存一次

自动保存的版本不会永久保存，只会在需要的时候（例如浏览器崩溃）用于恢复文章。

总结：时光机，任你驰骋

wp_get_post_revisions() 函数就像一个时光机，可以让你回到文章的过去，查看和恢复文章的历史版本。通过灵活地使用参数和过滤器，你可以定制你的时光之旅，实现各种各样的功能。

好了，今天的讲座就到这里。希望大家对 wp_get_post_revisions() 函数有了更深入的了解。下次再见！

发表回复 取消回复

发表回复取消回复