WC_API_Coupons::delete_coupon()
Delete a coupon
Method of the class: WC_API_Coupons{}
Hooks from the method
Return
Array|Int|WP_Error
.
Usage
$WC_API_Coupons = new WC_API_Coupons(); $WC_API_Coupons->delete_coupon( $id, $force );
- $id(int) (required)
- the coupon ID
- $force(true|false)
- true to permanently delete coupon, false to move to trash
Default: false
Changelog
Since 2.2 | Introduced. |
WC_API_Coupons::delete_coupon() WC API Coupons::delete coupon code WC 8.7.0
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 ) ); }