WC_Coupon_Data_Store_CPT::delete() │ public │ WC 3.0.0

Deletes a coupon from the database.

Method of the class: WC_Coupon_Data_Store_CPT{}

Return

null. Nothing (null).

Usage

$WC_Coupon_Data_Store_CPT = new WC_Coupon_Data_Store_CPT();
$WC_Coupon_Data_Store_CPT->delete( $coupon, $args );

$coupon(WC_Coupon) (required) (passed by reference — &)

Coupon object.

$args(array)

Array of args to pass to the delete method.
Default: array()

Changelog

WC_Coupon_Data_Store_CPT::delete() WC Coupon Data Store CPT::delete code ^{WC 9.4.2}

public function delete( &$coupon, $args = array() ) {
	$args = wp_parse_args(
		$args,
		array(
			'force_delete' => false,
		)
	);

	$id = $coupon->get_id();

	if ( ! $id ) {
		return;
	}

	if ( $args['force_delete'] ) {
		wp_delete_post( $id );

		wp_cache_delete( WC_Cache_Helper::get_cache_prefix( 'coupons' ) . 'coupon_id_from_code_' . $coupon->get_code(), 'coupons' );

		$coupon->set_id( 0 );
		do_action( 'woocommerce_delete_coupon', $id );
	} else {
		wp_trash_post( $id );
		$coupon->set_status( 'trash' );
		do_action( 'woocommerce_trash_coupon', $id );
	}
}