WC_API_Orders::delete_order( int $id, bool $force = false )
Delete an order
Description Description
Parameters Parameters
- $id
-
(Required) the order ID
- $force
-
(Optional) true to permanently delete order, false to move to trash
Default value: false
Return Return
(array|WP_Error)
Source Source
File: includes/legacy/api/v2/class-wc-api-orders.php
public function delete_order( $id, $force = false ) {
$id = $this->validate_request( $id, $this->post_type, 'delete' );
if ( is_wp_error( $id ) ) {
return $id;
}
wc_delete_shop_order_transients( $id );
do_action( 'woocommerce_api_delete_order', $id, $this );
return $this->delete( $id, 'order', ( 'true' === $force ) );
}