wp_delete_post_revision( int|WP_Post $revision_id ): WP_Post|false|null

Deletes a revision.


Description

Deletes the row from the posts table corresponding to the specified revision.


Top ↑

Parameters

$revision_id int|WP_Post Required
Revision ID or revision object.

Top ↑

Return

WP_Post|false|null Null or false if error, deleted post object if success.


Top ↑

Source

File: wp-includes/revision.php. View all references

function wp_delete_post_revision( $revision_id ) {
	$revision = wp_get_post_revision( $revision_id );
	if ( ! $revision ) {
		return $revision;
	}

	$delete = wp_delete_post( $revision->ID );
	if ( $delete ) {
		/**
		 * Fires once a post revision has been deleted.
		 *
		 * @since 2.6.0
		 *
		 * @param int     $revision_id Post revision ID.
		 * @param WP_Post $revision    Post revision object.
		 */
		do_action( 'wp_delete_post_revision', $revision->ID, $revision );
	}

	return $delete;
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

User Contributed Notes

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