WC_Abstract_Legacy_Order::update_coupon() public WC 1.0

Update coupon for order. Note this does not update order totals.

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

Return

Int. updated order item ID

Usage

$WC_Abstract_Legacy_Order = new WC_Abstract_Legacy_Order();
$WC_Abstract_Legacy_Order->update_coupon( $item, $args );

$args(array) (required)

-

Code of WC_Abstract_Legacy_Order::update_coupon() WC Abstract Legacy Order::update coupon ^{WC 5.0.0}

<?php
public function update_coupon( $item, $args ) {
	wc_deprecated_function( 'WC_Order::update_coupon', '3.0', 'an interaction with the WC_Order_Item_Coupon class' );
	if ( is_numeric( $item ) ) {
		$item = $this->get_item( $item );
	}
	if ( ! is_object( $item ) || ! $item->is_type( 'coupon' ) ) {
		return false;
	}
	if ( ! $this->get_id() ) {
		$this->save(); // Order must exist
	}

	// BW compatibility for old args
	if ( isset( $args['discount_amount'] ) ) {
		$args['discount'] = $args['discount_amount'];
	}
	if ( isset( $args['discount_amount_tax'] ) ) {
		$args['discount_tax'] = $args['discount_amount_tax'];
	}

	$item->set_order_id( $this->get_id() );
	$item->set_props( $args );
	$item->save();

	do_action( 'woocommerce_order_update_coupon', $this->get_id(), $item->get_id(), $args );

	return $item->get_id();
}