exists = $this->get_coupon( $code ); } /** * __isset function. * * @param mixed $key * @return bool */ public function __isset( $key ) { if ( in_array( $key, array( 'coupon_custom_fields', 'type', 'amount' ) ) ) { return true; } return false; } /** * __get function. * * @param mixed $key * @return mixed */ public function __get( $key ) { // Get values or default if not set if ( 'coupon_custom_fields' === $key ) { $value = $this->id ? get_post_meta( $this->id ) : array(); } elseif ( 'type' === $key ) { $value = $this->discount_type; } elseif ( 'amount' === $key ) { $value = $this->coupon_amount; } else { $value = ''; } return $value; } /** * Checks the coupon type. * * @param string $type Array or string of types * @return bool */ public function is_type( $type ) { return ( $this->discount_type == $type || ( is_array( $type ) && in_array( $this->discount_type, $type ) ) ) ? true : false; } /** * Gets an coupon from the database. * * @param string $code * @return bool */ public function get_coupon( $code ) { $this->code = apply_filters( 'woocommerce_coupon_code', $code ); // Coupon data lets developers create coupons through code if ( $coupon = apply_filters( 'woocommerce_get_shop_coupon_data', false, $code ) ) { $this->populate( $coupon ); return true; } else { global $wpdb; $coupon_id = $wpdb->get_var( $wpdb->prepare( apply_filters( 'woocommerce_coupon_code_query', "SELECT ID FROM $wpdb->posts WHERE post_title = %s AND post_type = 'shop_coupon' AND post_status = 'publish'" ), $this->code ) ); if ( ( $this->id = $coupon_id ) && $this->code === get_the_title( $this->id ) ) { $this->populate(); return true; } } return false; } /** * Populates an order from the loaded post data. */ public function populate( $data = array() ) { $defaults = array( 'discount_type' => 'fixed_cart', 'coupon_amount' => 0, 'individual_use' => 'no', 'product_ids' => array(), 'exclude_product_ids' => array(), 'usage_limit' => '', 'usage_limit_per_user' => '', 'limit_usage_to_x_items' => '', 'usage_count' => '', 'expiry_date' => '', 'apply_before_tax' => 'yes', 'free_shipping' => 'no', 'product_categories' => array(), 'exclude_product_categories' => array(), 'exclude_sale_items' => 'no', 'minimum_amount' => '', 'maximum_amount' => '', 'customer_email' => array() ); foreach ( $defaults as $key => $value ) { // Try to load from meta if an ID is present if ( $this->id ) { $this->$key = get_post_meta( $this->id, $key, true ); } else { $this->$key = ! empty( $data[ $key ] ) ? wc_clean( $data[ $key ] ) : ''; // Backwards compat field names @deprecated if ( 'coupon_amount' === $key ) { $this->coupon_amount = ! empty( $data[ 'amount' ] ) ? wc_clean( $data[ 'amount' ] ) : $this->coupon_amount; } elseif ( 'discount_type' === $key ) { $this->discount_type = ! empty( $data[ 'type' ] ) ? wc_clean( $data[ 'type' ] ) : $this->discount_type; } } if ( empty( $this->$key ) ) { $this->$key = $value; } elseif ( in_array( $key, array( 'product_ids', 'exclude_product_ids', 'product_categories', 'exclude_product_categories', 'customer_email' ) ) ) { $this->$key = $this->format_array( $this->$key ); } elseif ( in_array( $key, array( 'usage_limit', 'usage_limit_per_user', 'limit_usage_to_x_items', 'usage_count' ) ) ) { $this->$key = absint( $this->$key ); } elseif( 'expiry_date' === $key ) { $this->expiry_date = $this->expiry_date && ! is_numeric( $this->expiry_date ) ? strtotime( $this->expiry_date ) : $this->expiry_date; } } do_action( 'woocommerce_coupon_loaded', $this ); } /** * Format loaded data as array * @param string|array $maybe_array * @return array */ public function format_array( $maybe_array ) { if ( ! is_array( $maybe_array ) ) { if ( is_serialized( $maybe_array ) ) { $array = maybe_unserialize( $array ); } else { $array = explode( ',', $array ); } return array_filter( array_map( 'trim', array_map( 'strtolower', $array ) ) ); } return $maybe_array; } /** * Check if coupon needs applying before tax. * * @return bool */ public function apply_before_tax() { return 'yes' === $this->apply_before_tax; } /** * Check if a coupon enables free shipping. * * @return bool */ public function enable_free_shipping() { return 'yes' === $this->free_shipping; } /** * Check if a coupon excludes sale items. * * @return bool */ public function exclude_sale_items() { return 'yes' === $this->exclude_sale_items; } /** * Increase usage count for current coupon. * * @access public * @param string $used_by Either user ID or billing email * @return void */ public function inc_usage_count( $used_by = '' ) { if ( $this->id ) { update_post_meta( $this->id, 'usage_count', ( $this->usage_count ++ ) ); if ( $used_by ) { add_post_meta( $this->id, '_used_by', strtolower( $used_by ) ); } } } /** * Decrease usage count for current coupon. * * @access public * @param string $used_by Either user ID or billing email * @return void */ public function dcr_usage_count( $used_by = '' ) { if ( $this->id ) { global $wpdb; update_post_meta( $this->id, 'usage_count', ( $this->usage_count -- ) ); // Delete 1 used by meta $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_used_by' AND meta_value = %s AND post_id = %d LIMIT 1;", $used_by, $this->id ) ); if ( $meta_id ) { delete_metadata_by_mid( 'post', $meta_id ); } } } /** * Returns the error_message string * * @access public * @return string */ public function get_error_message() { return $this->error_message; } /** * is_valid function. * * Check if a coupon is valid. Return a reason code if invalid. Reason codes: * * @access public * @return boolean validity or a WP_Error if not valid */ public function is_valid() { $error_code = null; $valid = true; $error = false; if ( $this->exists ) { // Usage Limit if ( $this->usage_limit > 0 ) { if ( $this->usage_count >= $this->usage_limit ) { $valid = false; $error_code = self::E_WC_COUPON_USAGE_LIMIT_REACHED; } } // Per user usage limit - check here if user is logged in (against user IDs) // Checked again for emails later on in WC_Cart::check_customer_coupons() if ( $this->usage_limit_per_user > 0 && is_user_logged_in() ) { $used_by = (array) get_post_meta( $this->id, '_used_by' ); $usage_count = sizeof( array_keys( $used_by, get_current_user_id() ) ); if ( $usage_count >= $this->usage_limit_per_user ) { $valid = false; $error_code = self::E_WC_COUPON_USAGE_LIMIT_REACHED; } } // Expired if ( $this->expiry_date ) { if ( current_time( 'timestamp' ) > $this->expiry_date ) { $valid = false; $error_code = self::E_WC_COUPON_EXPIRED; } } // Minimum spend if ( $this->minimum_amount > 0 ) { if ( $this->minimum_amount > WC()->cart->subtotal ) { $valid = false; $error_code = self::E_WC_COUPON_MIN_SPEND_LIMIT_NOT_MET; } } // Maximum spend if ( $this->maximum_amount > 0 ) { if ( $this->maximum_amount < WC()->cart->subtotal ) { $valid = false; $error_code = self::E_WC_COUPON_MAX_SPEND_LIMIT_MET; } } // Product ids - If a product included is found in the cart then its valid if ( sizeof( $this->product_ids ) > 0 ) { $valid_for_cart = false; if ( sizeof( WC()->cart->get_cart() ) > 0 ) { foreach( WC()->cart->get_cart() as $cart_item_key => $cart_item ) { if ( in_array( $cart_item['product_id'], $this->product_ids ) || in_array( $cart_item['variation_id'], $this->product_ids ) || in_array( $cart_item['data']->get_parent(), $this->product_ids ) ) $valid_for_cart = true; } } if ( ! $valid_for_cart ) { $valid = false; $error_code = self::E_WC_COUPON_NOT_APPLICABLE; } } // Category ids - If a product included is found in the cart then its valid if ( sizeof( $this->product_categories ) > 0 ) { $valid_for_cart = false; if ( sizeof( WC()->cart->get_cart() ) > 0 ) { foreach( WC()->cart->get_cart() as $cart_item_key => $cart_item ) { $product_cats = wp_get_post_terms($cart_item['product_id'], 'product_cat', array("fields" => "ids")); if ( sizeof( array_intersect( $product_cats, $this->product_categories ) ) > 0 ) $valid_for_cart = true; } } if ( ! $valid_for_cart ) { $valid = false; $error_code = self::E_WC_COUPON_NOT_APPLICABLE; } } // Exclude Sale Items check for product coupons - valid if a non-sale item is present if ( 'yes' === $this->exclude_sale_items && $this->is_type( array( 'fixed_product', 'percent_product' ) ) ) { $valid_for_cart = false; $product_ids_on_sale = wc_get_product_ids_on_sale(); if ( sizeof( WC()->cart->get_cart() ) > 0 ) { foreach( WC()->cart->get_cart() as $cart_item_key => $cart_item ) { if ( sizeof( array_intersect( array( absint( $cart_item['product_id'] ), absint( $cart_item['variation_id'] ), $cart_item['data']->get_parent() ), $product_ids_on_sale ) ) === 0 ) { // not on sale $valid_for_cart = true; } } } if ( ! $valid_for_cart ) { $valid = false; $error_code = self::E_WC_COUPON_NOT_VALID_SALE_ITEMS; } } // Cart discounts cannot be added if non-eligble product is found in cart if ( ! $this->is_type( array( 'fixed_product', 'percent_product' ) ) ) { // Exclude Products if ( sizeof( $this->exclude_product_ids ) > 0 ) { $valid_for_cart = true; if ( sizeof( WC()->cart->get_cart() ) > 0 ) { foreach( WC()->cart->get_cart() as $cart_item_key => $cart_item ) { if ( in_array( $cart_item['product_id'], $this->exclude_product_ids ) || in_array( $cart_item['variation_id'], $this->exclude_product_ids ) || in_array( $cart_item['data']->get_parent(), $this->exclude_product_ids ) ) { $valid_for_cart = false; } } } if ( ! $valid_for_cart ) { $valid = false; $error_code = self::E_WC_COUPON_EXCLUDED_PRODUCTS; } } // Exclude Sale Items if ( $this->exclude_sale_items == 'yes' ) { $valid_for_cart = true; $product_ids_on_sale = wc_get_product_ids_on_sale(); if ( sizeof( WC()->cart->get_cart() ) > 0 ) { foreach( WC()->cart->get_cart() as $cart_item_key => $cart_item ) { if ( in_array( $cart_item['product_id'], $product_ids_on_sale, true ) || in_array( $cart_item['variation_id'], $product_ids_on_sale, true ) || in_array( $cart_item['data']->get_parent(), $product_ids_on_sale, true ) ) { $valid_for_cart = false; } } } if ( ! $valid_for_cart ) { $valid = false; $error_code = self::E_WC_COUPON_NOT_VALID_SALE_ITEMS; } } // Exclude Categories if ( sizeof( $this->exclude_product_categories ) > 0 ) { $valid_for_cart = true; if ( sizeof( WC()->cart->get_cart() ) > 0 ) { foreach( WC()->cart->get_cart() as $cart_item_key => $cart_item ) { $product_cats = wp_get_post_terms( $cart_item['product_id'], 'product_cat', array( "fields" => "ids" ) ); if ( sizeof( array_intersect( $product_cats, $this->exclude_product_categories ) ) > 0 ) { $valid_for_cart = false; } } } if ( ! $valid_for_cart ) { $valid = false; $error_code = self::E_WC_COUPON_EXCLUDED_CATEGORIES; } } } $valid = apply_filters( 'woocommerce_coupon_is_valid', $valid, $this ); if ( $valid ) { return true; } else { if ( is_null( $error_code ) ) $error_code = self::E_WC_COUPON_INVALID_FILTERED; } } else { $error_code = self::E_WC_COUPON_NOT_EXIST; } if ( $error_code ) { $this->error_message = $this->get_coupon_error( $error_code ); } return false; } /** * Check if a coupon is valid * * @return bool */ public function is_valid_for_cart() { return apply_filters( 'woocommerce_coupon_is_valid_for_cart', $this->is_type( array( 'fixed_cart', 'percent' ) ), $this ); } /** * Check if a coupon is valid for a product * * @param WC_Product $product * @return boolean */ public function is_valid_for_product( $product, $values = array() ) { if ( ! $this->is_type( array( 'fixed_product', 'percent_product' ) ) ) { return apply_filters( 'woocommerce_coupon_is_valid_for_product', false, $product, $this, $values ); } $valid = false; $product_cats = wp_get_post_terms( $product->id, 'product_cat', array( "fields" => "ids" ) ); // Specific products get the discount if ( sizeof( $this->product_ids ) > 0 ) { if ( in_array( $product->id, $this->product_ids ) || ( isset( $product->variation_id ) && in_array( $product->variation_id, $this->product_ids ) ) || in_array( $product->get_parent(), $this->product_ids ) ) { $valid = true; } // Category discounts } elseif ( sizeof( $this->product_categories ) > 0 ) { if ( sizeof( array_intersect( $product_cats, $this->product_categories ) ) > 0 ) { $valid = true; } } else { // No product ids - all items discounted $valid = true; } // Specific product ID's excluded from the discount if ( sizeof( $this->exclude_product_ids ) > 0 ) { if ( in_array( $product->id, $this->exclude_product_ids ) || ( isset( $product->variation_id ) && in_array( $product->variation_id, $this->exclude_product_ids ) ) || in_array( $product->get_parent(), $this->exclude_product_ids ) ) { $valid = false; } } // Specific categories excluded from the discount if ( sizeof( $this->exclude_product_categories ) > 0 ) { if ( sizeof( array_intersect( $product_cats, $this->exclude_product_categories ) ) > 0 ) { $valid = false; } } // Sale Items excluded from discount if ( $this->exclude_sale_items == 'yes' ) { $product_ids_on_sale = wc_get_product_ids_on_sale(); if ( in_array( $product->id, $product_ids_on_sale, true ) || ( isset( $product->variation_id ) && in_array( $product->variation_id, $product_ids_on_sale, true ) ) || in_array( $product->get_parent(), $product_ids_on_sale, true ) ) { $valid = false; } } return apply_filters( 'woocommerce_coupon_is_valid_for_product', $valid, $product, $this, $values ); } /** * Get discount amount for a cart item * * @param float $discounting_amount Amount the coupon is being applied to * @param array|null $cart_item Cart item being discounted if applicable * @param boolean $single True if discounting a single qty item, false if its the line * @return float Amount this coupon has discounted */ public function get_discount_amount( $discounting_amount, $cart_item = null, $single = false ) { $discount = 0; if ( $this->is_type( 'fixed_product' ) ) { $discount = $discounting_amount < $this->coupon_amount ? $discounting_amount : $this->coupon_amount; // If dealing with a line and not a single item, we need to multiple fixed discount by cart item qty. if ( ! $single && ! is_null( $cart_item ) ) { // Discount for the line. $discount = $discount * $cart_item['quantity']; } } elseif ( $this->is_type( array( 'percent_product', 'percent' ) ) ) { $discount = round( ( $discounting_amount / 100 ) * $this->coupon_amount, WC()->cart->dp ); } elseif ( $this->is_type( 'fixed_cart' ) ) { if ( ! is_null( $cart_item ) ) { /** * This is the most complex discount - we need to divide the discount between rows based on their price in * proportion to the subtotal. This is so rows with different tax rates get a fair discount, and so rows * with no price (free) don't get discounted. * * Get item discount by dividing item cost by subtotal to get a % */ $discount_percent = 0; if ( WC()->cart->subtotal_ex_tax ) { $discount_percent = ( $cart_item['data']->get_price_excluding_tax() * $cart_item['quantity'] ) / WC()->cart->subtotal_ex_tax; } $discount = min( ( $this->coupon_amount * $discount_percent ) / $cart_item['quantity'], $discounting_amount ); } else { $discount = min( $this->coupon_amount, $discounting_amount ); } } // Handle the limit_usage_to_x_items option if ( $this->is_type( array( 'percent_product', 'fixed_product' ) ) && ! is_null( $cart_item ) ) { $qty = '' === $this->limit_usage_to_x_items ? $cart_item['quantity'] : min( $this->limit_usage_to_x_items, $cart_item['quantity'] ); // Reduce limits $this->limit_usage_to_x_items = max( 0, $this->limit_usage_to_x_items - $qty ); if ( $single ) { $discount = ( $discount * $qty ) / $cart_item['quantity']; } else { $discount = ( $discount / $cart_item['quantity'] ) * $qty; } } return apply_filters( 'woocommerce_coupon_get_discount_amount', $discount, $discounting_amount, $cart_item, $single, $this ); } /** * Converts one of the WC_Coupon message/error codes to a message string and * displays the message/error. * * @param int $msg_code Message/error code. * @return void */ public function add_coupon_message( $msg_code ) { if ( $msg_code < 200 ) { wc_add_notice( $this->get_coupon_error( $msg_code ), 'error' ); } else { wc_add_notice( $this->get_coupon_message( $msg_code ) ); } } /** * Map one of the WC_Coupon message codes to a message string * * @param integer $msg_code * @return string| Message/error string */ public function get_coupon_message( $msg_code ) { switch ( $msg_code ) { case self::WC_COUPON_SUCCESS : $msg = __( 'Coupon code applied successfully.', 'woocommerce' ); break; case self::WC_COUPON_REMOVED : $msg = __( 'Coupon code removed successfully.', 'woocommerce' ); break; default: $msg = ''; break; } return apply_filters( 'woocommerce_coupon_message', $msg, $msg_code, $this ); } /** * Map one of the WC_Coupon error codes to a message string * * @param int $err_code Message/error code. * @return string| Message/error string */ public function get_coupon_error( $err_code ) { switch ( $err_code ) { case self::E_WC_COUPON_INVALID_FILTERED: $err = __( 'Coupon is not valid.', 'woocommerce' ); break; case self::E_WC_COUPON_NOT_EXIST: $err = __( 'Coupon does not exist!', 'woocommerce' ); break; case self::E_WC_COUPON_INVALID_REMOVED: $err = sprintf( __( 'Sorry, it seems the coupon "%s" is invalid - it has now been removed from your order.', 'woocommerce' ), $this->code ); break; case self::E_WC_COUPON_NOT_YOURS_REMOVED: $err = sprintf( __( 'Sorry, it seems the coupon "%s" is not yours - it has now been removed from your order.', 'woocommerce' ), $this->code ); break; case self::E_WC_COUPON_ALREADY_APPLIED: $err = __( 'Coupon code already applied!', 'woocommerce' ); break; case self::E_WC_COUPON_ALREADY_APPLIED_INDIV_USE_ONLY: $err = sprintf( __( 'Sorry, coupon "%s" has already been applied and cannot be used in conjunction with other coupons.', 'woocommerce' ), $this->code ); break; case self::E_WC_COUPON_USAGE_LIMIT_REACHED: $err = __( 'Coupon usage limit has been reached.', 'woocommerce' ); break; case self::E_WC_COUPON_EXPIRED: $err = __( 'This coupon has expired.', 'woocommerce' ); break; case self::E_WC_COUPON_MIN_SPEND_LIMIT_NOT_MET: $err = sprintf( __( 'The minimum spend for this coupon is %s.', 'woocommerce' ), wc_price( $this->minimum_amount ) ); break; case self::E_WC_COUPON_MAX_SPEND_LIMIT_MET: $err = sprintf( __( 'The maximum spend for this coupon is %s.', 'woocommerce' ), wc_price( $this->maximum_amount ) ); break; case self::E_WC_COUPON_NOT_APPLICABLE: $err = __( 'Sorry, this coupon is not applicable to your cart contents.', 'woocommerce' ); break; case self::E_WC_COUPON_EXCLUDED_PRODUCTS: // Store excluded products that are in cart in $products $products = array(); if ( sizeof( WC()->cart->get_cart() ) > 0 ) { foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) { if ( in_array( $cart_item['product_id'], $this->exclude_product_ids ) || in_array( $cart_item['variation_id'], $this->exclude_product_ids ) || in_array( $cart_item['data']->get_parent(), $this->exclude_product_ids ) ) { $products[] = $cart_item['data']->get_title(); } } } $err = sprintf( __( 'Sorry, this coupon is not applicable to the products: %s.', 'woocommerce' ), implode( ', ', $products ) ); break; case self::E_WC_COUPON_EXCLUDED_CATEGORIES: // Store excluded categories that are in cart in $categories $categories = array(); if ( sizeof( WC()->cart->get_cart() ) > 0 ) { foreach( WC()->cart->get_cart() as $cart_item_key => $cart_item ) { $product_cats = wp_get_post_terms( $cart_item['product_id'], 'product_cat', array( "fields" => "ids" ) ); if ( sizeof( $intersect = array_intersect( $product_cats, $this->exclude_product_categories ) ) > 0 ) { foreach( $intersect as $cat_id) { $cat = get_term( $cat_id, 'product_cat' ); $categories[] = $cat->name; } } } } $err = sprintf( __( 'Sorry, this coupon is not applicable to the categories: %s.', 'woocommerce' ), implode( ', ', $categories ) ); break; case self::E_WC_COUPON_NOT_VALID_SALE_ITEMS: $err = __( 'Sorry, this coupon is not valid for sale items.', 'woocommerce' ); break; default: $err = ''; break; } return apply_filters( 'woocommerce_coupon_error', $err, $err_code, $this ); } /** * Map one of the WC_Coupon error codes to an error string * No coupon instance will be available where a coupon does not exist, * so this static method exists. * * @param int $err_code Error code * @return string| Error string */ public static function get_generic_coupon_error( $err_code ) { switch ( $err_code ) { case self::E_WC_COUPON_NOT_EXIST: $err = __( 'Coupon does not exist!', 'woocommerce' ); break; case self::E_WC_COUPON_PLEASE_ENTER: $err = __( 'Please enter a coupon code.', 'woocommerce' ); break; default: $err = ''; break; } // When using this static method, there is no $this to pass to filter return apply_filters( 'woocommerce_coupon_error', $err, $err_code, null ); } }