WC_Coupon::__construct( mixed $data = '' )

Coupon constructor. Loads coupon data.

Contents

Description Description

Parameters Parameters

$data

(Optional) Coupon data, object, ID or code.

Default value: ''

Top ↑

Source Source

File: includes/class-wc-coupon.php 

	public function __construct( $data = '' ) {
		parent::__construct( $data );

		// If we already have a coupon object, read it again.
		if ( $data instanceof WC_Coupon ) {
			$this->set_id( absint( $data->get_id() ) );
			$this->read_object_from_database();
			return;
		}

		// This filter allows custom coupon objects to be created on the fly.
		$coupon = apply_filters( 'woocommerce_get_shop_coupon_data', false, $data, $this );

		if ( $coupon ) {
			$this->read_manual_coupon( $data, $coupon );
			return;
		}

		// Try to load coupon using ID or code.
		if ( is_int( $data ) && 'shop_coupon' === get_post_type( $data ) ) {
			$this->set_id( $data );
		} elseif ( ! empty( $data ) ) {
			$id = wc_get_coupon_id_by_code( $data );
			// Need to support numeric strings for backwards compatibility.
			if ( ! $id && 'shop_coupon' === get_post_type( $data ) ) {
				$this->set_id( $data );
			} else {
				$this->set_id( $id );
				$this->set_code( $data );
			}
		} else {
			$this->set_object_read( true );
		}

		$this->read_object_from_database();
	}

Expand full source code Collapse full source code

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
packages/woocommerce-blocks/src/StoreApi/Utilities/OrderController.php: OrderController::get_coupon()

Convert a coupon code to a coupon object.
packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::apply_coupon()

Based on the core cart class but returns errors rather than rendering notices directly.
packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::validate_cart_coupons()

Validate all coupons in the cart and check for errors.
packages/woocommerce-blocks/src/StoreApi/Utilities/CartController.php: CartController::get_cart_coupon_errors()

Validate all items in the cart and get a list of errors.
packages/woocommerce-blocks/src/StoreApi/Routes/CartRemoveCoupon.php: CartRemoveCoupon::get_route_post_response()

Handle the request and return a valid response for this endpoint.
packages/woocommerce-blocks/src/StoreApi/Schemas/CartCouponSchema.php: CartCouponSchema::coupon_exists()

Check given coupon exists.
packages/woocommerce-blocks/src/StoreApi/Schemas/CartCouponSchema.php: CartCouponSchema::get_item_response()

Generate a response from passed coupon code.
includes/admin/list-tables/class-wc-admin-list-table-coupons.php: WC_Admin_List_Table_Coupons::prepare_row_data()

Pre-fetch any data for the row each column has access to it. the_coupon global is there for bw compat.
includes/admin/meta-boxes/class-wc-meta-box-coupon-data.php: WC_Meta_Box_Coupon_Data::output()

Output the metabox.
includes/admin/meta-boxes/class-wc-meta-box-coupon-data.php: WC_Meta_Box_Coupon_Data::save()

Save meta box data.
includes/legacy/api/class-wc-rest-legacy-coupons-controller.php: WC_REST_Legacy_Coupons_Controller::prepare_item_for_response()

Prepare a single coupon output for response.
includes/legacy/api/class-wc-rest-legacy-coupons-controller.php: WC_REST_Legacy_Coupons_Controller::prepare_item_for_database()

Prepare a single coupon for create or update.
includes/legacy/api/v2/class-wc-api-coupons.php: WC_API_Coupons::get_coupon()

Get the coupon for the given ID
includes/class-wc-cart.php: WC_Cart::get_coupons()

Get array of applied coupon objects and codes.
includes/class-wc-cart.php: WC_Cart::check_customer_coupons()

Check for user coupons (now that we have billing email). If a coupon is invalid, add an error.
includes/class-wc-cart.php: WC_Cart::apply_coupon()

Applies a coupon code passed to the method.
includes/class-wc-cart.php: WC_Cart::check_cart_coupons()

Check cart coupons for errors.
includes/wc-cart-functions.php: wc_cart_totals_coupon_html()

Get coupon display HTML.
includes/wc-cart-functions.php: wc_cart_totals_coupon_label()

Get a coupon label.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::remove_coupon()

Remove a coupon from the order and recalculate totals.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::recalculate_coupons()

Apply all coupons in this order again to all line items.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::hold_applied_coupons()

Check and records coupon usage tentatively so that counts validation is correct. Display an error if coupon usage limit has been reached.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::apply_coupon()

Apply a coupon to the order and recalculate totals.
includes/wc-order-functions.php: wc_update_coupon_usage_counts()

Update used coupon amount for each coupon within an order.
packages/woocommerce-admin/src/API/Reports/Coupons/DataStore.php: DataStore::include_extended_info()

Enriches the coupon data with extra attributes.
includes/rest-api/Controllers/Version3/class-wc-rest-orders-controller.php: WC_REST_Orders_Controller::calculate_coupons()

Calculate coupons.
includes/rest-api/Controllers/Version1/class-wc-rest-coupons-v1-controller.php: WC_REST_Coupons_V1_Controller::prepare_item_for_response()

Prepare a single coupon output for response.
includes/rest-api/Controllers/Version1/class-wc-rest-coupons-v1-controller.php: WC_REST_Coupons_V1_Controller::prepare_item_for_database()

Prepare a single coupon for create or update.
includes/rest-api/Controllers/Version2/class-wc-rest-coupons-v2-controller.php: WC_REST_Coupons_V2_Controller::prepare_object_for_database()

Prepare a single coupon for create or update.
includes/rest-api/Controllers/Version2/class-wc-rest-coupons-v2-controller.php: WC_REST_Coupons_V2_Controller::get_object()

Get object.
Show 25 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.