WC_API_Coupons::delete_coupon() public WC 1.0

Delete a coupon

{} It's a method of the class: WC_API_Coupons{}

No Hooks.

Return

Array|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

Code of WC_API_Coupons::delete_coupon() WC API Coupons::delete coupon ^{WC 5.7.1}

public function delete_coupon( $id, $force = false ) {

	$id = $this->validate_request( $id, 'shop_coupon', 'delete' );

	if ( is_wp_error( $id ) ) {
		return $id;
	}

	return $this->delete( $id, 'shop_coupon', ( 'true' === $force ) );
}