Automattic\WooCommerce\Internal\RestApi\Routes\V4\Refunds

Controller::delete_item │ public │ WC 1.0

Delete a single item.

Method of the class: Controller{}

Returns

WP_REST_Response|WP_Error.

Usage

$Controller = new Controller();
$Controller->delete_item( $request );

$request(WP_REST_Request) (required)

Full details about the request.

Controller::delete_item() Controller::delete item code ^{WC 10.4.3}

public function delete_item( $request ) {
	$refund = wc_get_order( (int) $request['id'] );

	if ( ! $this->is_valid_refund_for_request( $refund ) ) {
		return $this->get_route_error_by_code( self::INVALID_ID );
	}

	$request->set_param( 'context', 'edit' );

	$response = new WP_REST_Response( null, 204 );
	$result   = $refund->delete( true );

	if ( ! $result ) {
		return $this->get_route_error_by_code( self::CANNOT_DELETE );
	}

	/**
	 * Fires after a single object is deleted or trashed via the REST API.
	 *
	 * @param WC_Order_Refund  $refund   The deleted object.
	 * @param WP_REST_Response $response The response data.
	 * @param WP_REST_Request  $request  The request sent to the API.
	 * @since 10.2.0
	 */
	do_action( $this->get_hook_prefix() . 'deleted', $refund, $response, $request );

	return $response;
}