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

Deletes a revision.

Description

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

Parameters

$revisionint|WP_Postrequired
Revision ID or revision object.

Return

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

Source

function wp_delete_post_revision( $revision ) {
	$revision = wp_get_post_revision( $revision );

	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;
}

Hooks

do_action( ‘wp_delete_post_revision’, int $revision_id, WP_Post $revision )

Fires once a post revision has been deleted.

Changelog

VersionDescription
2.6.0Introduced.

User Contributed Notes

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