WC_API_Coupons::delete_coupon( int $id, bool $force = false )
Delete a coupon
Description Description
Parameters Parameters
- $id
-
(Required) the coupon ID
- $force
-
(Optional) true to permanently delete coupon, false to move to trash
Default value: false
Return Return
(array|WP_Error)
Source Source
File: includes/legacy/api/v2/class-wc-api-coupons.php
public function delete_coupon( $id, $force = false ) {
$id = $this->validate_request( $id, 'shop_coupon', 'delete' );
if ( is_wp_error( $id ) ) {
return $id;
}
do_action( 'woocommerce_api_delete_coupon', $id, $this );
return $this->delete( $id, 'shop_coupon', ( 'true' === $force ) );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.2 | Introduced. |