wp_list_post_revisions() WordPress Function

The wp_list_post_revisions() function is used to list all post revisions for a given post. This is useful for seeing all changes that have been made to a post, and for reverting back to a previous version if necessary.

wp_list_post_revisions( int|WP_Post $post_id, string $type = 'all' ) #

Displays a list of a post’s revisions.


Description

Can output either a UL with edit links or a TABLE with diff interface, and restore action links.


Top ↑

Parameters

$post_id

(int|WP_Post)(Optional) Post ID or WP_Post object. Default is global $post.

$type

(string)(Optional)'all' (default), 'revision' or 'autosave'

Default value: 'all'


Top ↑

Source

File: wp-includes/post-template.php

function wp_list_post_revisions( $post_id = 0, $type = 'all' ) {
	$post = get_post( $post_id );
	if ( ! $post ) {
		return;
	}

	// $args array with (parent, format, right, left, type) deprecated since 3.6.
	if ( is_array( $type ) ) {
		$type = ! empty( $type['type'] ) ? $type['type'] : $type;
		_deprecated_argument( __FUNCTION__, '3.6.0' );
	}

	$revisions = wp_get_post_revisions( $post->ID );
	if ( ! $revisions ) {
		return;
	}

	$rows = '';
	foreach ( $revisions as $revision ) {
		if ( ! current_user_can( 'read_post', $revision->ID ) ) {
			continue;
		}

		$is_autosave = wp_is_post_autosave( $revision );
		if ( ( 'revision' === $type && $is_autosave ) || ( 'autosave' === $type && ! $is_autosave ) ) {
			continue;
		}

		$rows .= "\t<li>" . wp_post_revision_title_expanded( $revision ) . "</li>\n";
	}

	echo "<div class='hide-if-js'><p>" . __( 'JavaScript must be enabled to use this feature.' ) . "</p></div>\n";

	echo "<ul class='post-revisions hide-if-no-js'>\n";
	echo $rows;
	echo '</ul>';
}


Top ↑

Changelog

Changelog
VersionDescription
2.6.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.