WP_REST_Posts_Controller::delete_item( WP_REST_Request $request ): WP_REST_Response|WP_Error

In this article

Deletes a single post.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

Source

public function delete_item( $request ) {	$post = $this->get_post( $request['id'] );	if ( is_wp_error( $post ) ) {	return $post;	}	$id = $post->ID;	$force = (bool) $request['force'];	$supports_trash = ( EMPTY_TRASH_DAYS > 0 );	if ( 'attachment' === $post->post_type ) {	$supports_trash = $supports_trash && MEDIA_TRASH;	}	/** * Filters whether a post is trashable. * * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug. * * Possible hook names include: * * - `rest_post_trashable` * - `rest_page_trashable` * - `rest_attachment_trashable` * * Pass false to disable Trash support for the post. * * @since 4.7.0 * * @param bool $supports_trash Whether the post type support trashing. * @param WP_Post $post The Post object being considered for trashing support. */	$supports_trash = apply_filters( "rest_{$this->post_type}_trashable", $supports_trash, $post );	if ( ! $this->check_delete_permission( $post ) ) {	return new WP_Error(	'rest_user_cannot_delete_post',	__( 'Sorry, you are not allowed to delete this post.' ),	array( 'status' => rest_authorization_required_code() )	);	}	$request->set_param( 'context', 'edit' );	// If we're forcing, then delete permanently.	if ( $force ) {	$previous = $this->prepare_item_for_response( $post, $request );	$result = wp_delete_post( $id, true );	$response = new WP_REST_Response();	$response->set_data(	array(	'deleted' => true,	'previous' => $previous->get_data(),	)	);	} else {	// If we don't support trashing for this type, error out.	if ( ! $supports_trash ) {	return new WP_Error(	'rest_trash_not_supported',	/* translators: %s: force=true */	sprintf( __( "The post does not support trashing. Set '%s' to delete." ), 'force=true' ),	array( 'status' => 501 )	);	}	// Otherwise, only trash if we haven't already.	if ( 'trash' === $post->post_status ) {	return new WP_Error(	'rest_already_trashed',	__( 'The post has already been deleted.' ),	array( 'status' => 410 )	);	}	/* * (Note that internally this falls through to `wp_delete_post()` * if the Trash is disabled.) */	$result = wp_trash_post( $id );	$post = get_post( $id );	$response = $this->prepare_item_for_response( $post, $request );	}	if ( ! $result ) {	return new WP_Error(	'rest_cannot_delete',	__( 'The post cannot be deleted.' ),	array( 'status' => 500 )	);	}	/** * Fires immediately after a single post is deleted or trashed via the REST API. * * They dynamic portion of the hook name, `$this->post_type`, refers to the post type slug. * * Possible hook names include: * * - `rest_delete_post` * - `rest_delete_page` * - `rest_delete_attachment` * * @since 4.7.0 * * @param WP_Post $post The deleted or trashed post. * @param WP_REST_Response $response The response data. * @param WP_REST_Request $request The request sent to the API. */	do_action( "rest_delete_{$this->post_type}", $post, $response, $request );	return $response; } 

Hooks

do_action( “rest_delete_{$this->post_type}”, WP_Post $post, WP_REST_Response $response, WP_REST_Request $request )

Fires immediately after a single post is deleted or trashed via the REST API.

apply_filters( “rest_{$this->post_type}_trashable”, bool $supports_trash, WP_Post $post )

Filters whether a post is trashable.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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