On this page
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_Post Required-
Revision ID or revision object.
Return
WP_Post|false|null Null or false if error, deleted post object if success.
Source
File: wp-includes/revision.php. View all references
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.
Related
Uses
| Uses | Description |
|---|---|
| wp_get_post_revision() wp-includes/revision.php | Gets a post revision. |
| wp_delete_post() wp-includes/post.php | Trashes or deletes a post or page. |
| do_action() wp-includes/plugin.php | Calls the callback functions that have been added to an action hook. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Autosaves_Controller::create_post_autosave() wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php | Creates autosave for the specified post. |
| wp_create_post_autosave() wp-admin/includes/post.php | Creates autosave data for the specified post from |
| wp_delete_post() wp-includes/post.php | Trashes or deletes a post or page. |
| wp_save_post_revision() wp-includes/revision.php | Creates a revision for the current version of a post. |
Changelog
| Version | Description |
|---|---|
| 2.6.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_delete_post_revision