WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Revisions_Controller::get_revision()

WP_REST_Revisions_Controller::get_revision( int $id ): WP_Post|WP_Error

In this article

Back to top

Get the revision, if the ID is valid.

Parameters

$idintrequired
Supplied ID.

Return

WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise.

Source

protected function get_revision( $id ) {
	$error = new WP_Error(
		'rest_post_invalid_id',
		__( 'Invalid revision ID.' ),
		array( 'status' => 404 )
	);

	if ( (int) $id <= 0 ) {
		return $error;
	}

	$revision = get_post( (int) $id );
	if ( empty( $revision ) || empty( $revision->ID ) || 'revision' !== $revision->post_type ) {
		return $error;
	}

	return $revision;
}

View all references View on Trac View on GitHub

UsesDescription
get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Used byDescription
WP_REST_Revisions_Controller::get_item()wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Retrieves one revision from the collection.

WP_REST_Revisions_Controller::delete_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Checks if a given request has access to delete a revision.

WP_REST_Revisions_Controller::delete_item()wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Deletes a single revision.

Changelog

VersionDescription
4.7.2Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.