W3cubDocs

/WordPress

wp_get_post_revision( int|WP_Post $post, string $output = OBJECT, string $filter = 'raw' )

Gets a post revision.

Description

Parameters

$post

(int|WP_Post) (Required) The post ID or object.

$output

(string) (Optional) The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Post object, an associative array, or a numeric array, respectively.

Default value: OBJECT

$filter

(string) (Optional) sanitation filter. See sanitize_post().

Default value: 'raw'

Return

(WP_Post|array|null) WP_Post (or array) on success, or null on failure.

Source

File: wp-includes/revision.php

function wp_get_post_revision( &$post, $output = OBJECT, $filter = 'raw' ) {
	if ( ! $revision = get_post( $post, OBJECT, $filter ) ) {
		return $revision;
	}
	if ( 'revision' !== $revision->post_type ) {
		return null;
	}

	if ( $output == OBJECT ) {
		return $revision;
	} elseif ( $output == ARRAY_A ) {
		$_revision = get_object_vars( $revision );
		return $_revision;
	} elseif ( $output == ARRAY_N ) {
		$_revision = array_values( get_object_vars( $revision ) );
		return $_revision;
	}

	return $revision;
}

Changelog

Version Description
2.6.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_get_post_revision