WC_Abstract_Order
Abstract Order.
Defined (1)
The class is defined in the following location(s).
- /includes/abstracts/abstract-wc-order.php
- abstract class WC_Abstract_Order extends WC_Abstract_Legacy_Order {
- /**
- * Order Data array. This is the core order data exposed in APIs since 3.0.0.
- *
- * Notes: cart_tax = cart_tax is the new name for the legacy 'order_tax'
- * which is the tax for items only, not shipping.
- *
- * @since 3.0.0
- * @var array
- */
- protected $data = array(
- 'parent_id' => 0,
- 'status' => '',
- 'currency' => '',
- 'version' => '',
- 'prices_include_tax' => false,
- 'date_created' => null,
- 'date_modified' => null,
- 'discount_total' => 0,
- 'discount_tax' => 0,
- 'shipping_total' => 0,
- 'shipping_tax' => 0,
- 'cart_tax' => 0,
- 'total' => 0,
- 'total_tax' => 0,
- );
- /**
- * Order items will be stored here, sometimes before they persist in the DB.
- *
- * @since 3.0.0
- * @var array
- */
- protected $items = array();
- /**
- * Order items that need deleting are stored here.
- *
- * @since 3.0.0
- * @var array
- */
- protected $items_to_delete = array();
- /**
- * Stores meta in cache for future reads.
- *
- * A group must be set to to enable caching.
- * @var string
- */
- protected $cache_group = 'orders';
- /**
- * Which data store to load.
- *
- * @var string
- */
- protected $data_store_name = 'order';
- /**
- * This is the name of this object type.
- * @var string
- */
- protected $object_type = 'order';
- /**
- * Get the order if ID is passed, otherwise the order is new and empty.
- * This class should NOT be instantiated, but the get_order function or new WC_Order_Factory.
- * should be used. It is possible, but the aforementioned are preferred and are the only.
- * methods that will be maintained going forward.
- *
- * @param int|object|WC_Order $order Order to read.
- */
- public function __construct( $order = 0 ) {
- parent::__construct( $order );
- if ( is_numeric( $order ) && $order > 0 ) {
- $this->set_id( $order );
- } elseif ( $order instanceof self ) {
- $this->set_id( $order->get_id() );
- } elseif ( ! empty( $order->ID ) ) {
- $this->set_id( $order->ID );
- } else {
- $this->set_object_read( true );
- }
- $this->data_store = WC_Data_Store::load( $this->data_store_name );
- if ( $this->get_id() > 0 ) {
- $this->data_store->read( $this );
- }
- }
- /**
- * Get internal type.
- *
- * @return string
- */
- public function get_type() {
- return 'shop_order';
- }
- /**
- * Get all class data in array format.
- *
- * @since 3.0.0
- * @return array
- */
- public function get_data() {
- return array_merge(
- array(
- 'id' => $this->get_id(),
- ),
- $this->data,
- array(
- 'meta_data' => $this->get_meta_data(),
- 'line_items' => $this->get_items( 'line_item' ),
- 'tax_lines' => $this->get_items( 'tax' ),
- 'shipping_lines' => $this->get_items( 'shipping' ),
- 'fee_lines' => $this->get_items( 'fee' ),
- 'coupon_lines' => $this->get_items( 'coupon' ),
- )
- );
- }
- /**
- |--------------------------------------------------------------------------
- | CRUD methods
- |--------------------------------------------------------------------------
- |
- | Methods which create, read, update and delete orders from the database.
- | Written in abstract fashion so that the way orders are stored can be
- | changed more easily in the future.
- |
- | A save method is included for convenience (chooses update or create based
- | on if the order exists yet).
- |
- */
- /**
- * Save data to the database.
- *
- * @since 3.0.0
- * @return int order ID
- */
- public function save() {
- if ( $this->data_store ) {
- // Trigger action before saving to the DB. Allows you to adjust object props before save.
- do_action( 'woocommerce_before_' . $this->object_type . '_object_save', $this, $this->data_store );
- if ( $this->get_id() ) {
- $this->data_store->update( $this );
- } else {
- $this->data_store->create( $this );
- }
- }
- $this->save_items();
- return $this->get_id();
- }
- /**
- * Save all order items which are part of this order.
- */
- protected function save_items() {
- foreach ( $this->items_to_delete as $item ) {
- $item->delete();
- }
- $this->items_to_delete = array();
- // Add/save items.
- foreach ( $this->items as $item_group => $items ) {
- if ( is_array( $items ) ) {
- foreach ( array_filter( $items ) as $item_key => $item ) {
- $item->set_order_id( $this->get_id() );
- $item_id = $item->save();
- // If ID changed (new item saved to DB)...
- if ( $item_id !== $item_key ) {
- $this->items[ $item_group ][ $item_id ] = $item;
- unset( $this->items[ $item_group ][ $item_key ] );
- }
- }
- }
- }
- }
- /**
- |--------------------------------------------------------------------------
- | Getters
- |--------------------------------------------------------------------------
- */
- /**
- * Get parent order ID.
- *
- * @since 3.0.0
- * @param string $context
- * @return integer
- */
- public function get_parent_id( $context = 'view' ) {
- return $this->get_prop( 'parent_id', $context );
- }
- /**
- * Gets order currency.
- *
- * @param string $context
- * @return string
- */
- public function get_currency( $context = 'view' ) {
- return $this->get_prop( 'currency', $context );
- }
- /**
- * Get order_version.
- *
- * @param string $context
- * @return string
- */
- public function get_version( $context = 'view' ) {
- return $this->get_prop( 'version', $context );
- }
- /**
- * Get prices_include_tax.
- *
- * @param string $context
- * @return bool
- */
- public function get_prices_include_tax( $context = 'view' ) {
- return $this->get_prop( 'prices_include_tax', $context );
- }
- /**
- * Get date_created.
- *
- * @param string $context
- * @return WC_DateTime|NULL object if the date is set or null if there is no date.
- */
- public function get_date_created( $context = 'view' ) {
- return $this->get_prop( 'date_created', $context );
- }
- /**
- * Get date_modified.
- *
- * @param string $context
- * @return WC_DateTime|NULL object if the date is set or null if there is no date.
- */
- public function get_date_modified( $context = 'view' ) {
- return $this->get_prop( 'date_modified', $context );
- }
- /**
- * Return the order statuses without wc- internal prefix.
- *
- * @param string $context
- * @return string
- */
- public function get_status( $context = 'view' ) {
- $status = $this->get_prop( 'status', $context );
- if ( empty( $status ) && 'view' === $context ) {
- // In view context, return the default status if no status has been set.
- $status = apply_filters( 'woocommerce_default_order_status', 'pending' );
- }
- return $status;
- }
- /**
- * Get discount_total.
- *
- * @param string $context
- * @return string
- */
- public function get_discount_total( $context = 'view' ) {
- return $this->get_prop( 'discount_total', $context );
- }
- /**
- * Get discount_tax.
- *
- * @param string $context
- * @return string
- */
- public function get_discount_tax( $context = 'view' ) {
- return $this->get_prop( 'discount_tax', $context );
- }
- /**
- * Get shipping_total.
- *
- * @param string $context
- * @return string
- */
- public function get_shipping_total( $context = 'view' ) {
- return $this->get_prop( 'shipping_total', $context );
- }
- /**
- * Get shipping_tax.
- *
- * @param string $context
- * @return string
- */
- public function get_shipping_tax( $context = 'view' ) {
- return $this->get_prop( 'shipping_tax', $context );
- }
- /**
- * Gets cart tax amount.
- *
- * @param string $context
- * @return float
- */
- public function get_cart_tax( $context = 'view' ) {
- return $this->get_prop( 'cart_tax', $context );
- }
- /**
- * Gets order grand total. incl. taxes. Used in gateways.
- *
- * @param string $context
- * @return float
- */
- public function get_total( $context = 'view' ) {
- return $this->get_prop( 'total', $context );
- }
- /**
- * Get total tax amount. Alias for get_order_tax().
- *
- * @param string $context
- * @return float
- */
- public function get_total_tax( $context = 'view' ) {
- return $this->get_prop( 'total_tax', $context );
- }
- /**
- |--------------------------------------------------------------------------
- | Non-CRUD Getters
- |--------------------------------------------------------------------------
- */
- /**
- * Gets the total discount amount.
- *
- * @param bool $ex_tax Show discount excl any tax.
- * @return float
- */
- public function get_total_discount( $ex_tax = true ) {
- if ( $ex_tax ) {
- $total_discount = $this->get_discount_total();
- } else {
- $total_discount = $this->get_discount_total() + $this->get_discount_tax();
- }
- return apply_filters( 'woocommerce_order_get_total_discount', round( $total_discount, WC_ROUNDING_PRECISION ), $this );
- }
- /**
- * Gets order subtotal.
- * @return float
- */
- public function get_subtotal() {
- $subtotal = 0;
- foreach ( $this->get_items() as $item ) {
- $subtotal += $item->get_subtotal();
- }
- return apply_filters( 'woocommerce_order_get_subtotal', (double) $subtotal, $this );
- }
- /**
- * Get taxes, merged by code, formatted ready for output.
- *
- * @return array
- */
- public function get_tax_totals() {
- $tax_totals = array();
- foreach ( $this->get_items( 'tax' ) as $key => $tax ) {
- $code = $tax->get_rate_code();
- if ( ! isset( $tax_totals[ $code ] ) ) {
- $tax_totals[ $code ] = new stdClass();
- $tax_totals[ $code ]->amount = 0;
- }
- $tax_totals[ $code ]->id = $key;
- $tax_totals[ $code ]->rate_id = $tax->get_rate_id();
- $tax_totals[ $code ]->is_compound = $tax->is_compound();
- $tax_totals[ $code ]->label = $tax->get_label();
- $tax_totals[ $code ]->amount += (float) $tax->get_tax_total() + (float) $tax->get_shipping_tax_total();
- $tax_totals[ $code ]->formatted_amount = wc_price( wc_round_tax_total( $tax_totals[ $code ]->amount ), array( 'currency' => $this->get_currency() ) );
- }
- if ( apply_filters( 'woocommerce_order_hide_zero_taxes', true ) ) {
- $amounts = array_filter( wp_list_pluck( $tax_totals, 'amount' ) );
- $tax_totals = array_intersect_key( $tax_totals, $amounts );
- }
- return apply_filters( 'woocommerce_order_get_tax_totals', $tax_totals, $this );
- }
- /**
- * Get all valid statuses for this order
- *
- * @since 3.0.0
- * @return array Internal status keys e.g. 'wc-processing'
- */
- protected function get_valid_statuses() {
- return array_keys( wc_get_order_statuses() );
- }
- /**
- * Get user ID. Used by orders, not other order types like refunds.
- *
- * @param string $context
- * @return int
- */
- public function get_user_id( $context = 'view' ) {
- return 0;
- }
- /**
- * Get user. Used by orders, not other order types like refunds.
- *
- * @return WP_User|false
- */
- public function get_user() {
- return false;
- }
- /**
- |--------------------------------------------------------------------------
- | Setters
- |--------------------------------------------------------------------------
- |
- | Functions for setting order data. These should not update anything in the
- | database itself and should only change what is stored in the class
- | object. However, for backwards compatibility pre 3.0.0 some of these
- | setters may handle both.
- */
- /**
- * Set parent order ID.
- *
- * @since 3.0.0
- * @param int $value
- * @throws WC_Data_Exception
- */
- public function set_parent_id( $value ) {
- if ( $value && ( $value === $this->get_id() || ! wc_get_order( $value ) ) ) {
- $this->error( 'order_invalid_parent_id', __( 'Invalid parent ID', 'woocommerce' ) );
- }
- $this->set_prop( 'parent_id', absint( $value ) );
- }
- /**
- * Set order status.
- *
- * @since 3.0.0
- * @param string $new_status Status to change the order to. No internal wc- prefix is required.
- * @return array details of change
- */
- public function set_status( $new_status ) {
- $old_status = $this->get_status();
- $new_status = 'wc-' === substr( $new_status, 0, 3 ) ? substr( $new_status, 3 ) : $new_status;
- // If setting the status, ensure it's set to a valid status.
- if ( true === $this->object_read ) {
- // Only allow valid new status
- if ( ! in_array( 'wc-' . $new_status, $this->get_valid_statuses() ) && 'trash' !== $new_status ) {
- $new_status = 'pending';
- }
- // If the old status is set but unknown (e.g. draft) assume its pending for action usage.
- if ( $old_status && ! in_array( 'wc-' . $old_status, $this->get_valid_statuses() ) && 'trash' !== $old_status ) {
- $old_status = 'pending';
- }
- }
- $this->set_prop( 'status', $new_status );
- return array(
- 'from' => $old_status,
- 'to' => $new_status,
- );
- }
- /**
- * Set order_version.
- *
- * @param string $value
- * @throws WC_Data_Exception
- */
- public function set_version( $value ) {
- $this->set_prop( 'version', $value );
- }
- /**
- * Set order_currency.
- *
- * @param string $value
- * @throws WC_Data_Exception
- */
- public function set_currency( $value ) {
- if ( $value && ! in_array( $value, array_keys( get_woocommerce_currencies() ) ) ) {
- $this->error( 'order_invalid_currency', __( 'Invalid currency code', 'woocommerce' ) );
- }
- $this->set_prop( 'currency', $value ? $value : get_woocommerce_currency() );
- }
- /**
- * Set prices_include_tax.
- *
- * @param bool $value
- * @throws WC_Data_Exception
- */
- public function set_prices_include_tax( $value ) {
- $this->set_prop( 'prices_include_tax', (bool) $value );
- }
- /**
- * Set date_created.
- *
- * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
- * @throws WC_Data_Exception
- */
- public function set_date_created( $date = null ) {
- $this->set_date_prop( 'date_created', $date );
- }
- /**
- * Set date_modified.
- *
- * @param string|integer|null $date UTC timestamp, or ISO 8601 DateTime. If the DateTime string has no timezone or offset, WordPress site timezone will be assumed. Null if their is no date.
- * @throws WC_Data_Exception
- */
- public function set_date_modified( $date = null ) {
- $this->set_date_prop( 'date_modified', $date );
- }
- /**
- * Set discount_total.
- *
- * @param string $value
- * @throws WC_Data_Exception
- */
- public function set_discount_total( $value ) {
- $this->set_prop( 'discount_total', wc_format_decimal( $value ) );
- }
- /**
- * Set discount_tax.
- *
- * @param string $value
- * @throws WC_Data_Exception
- */
- public function set_discount_tax( $value ) {
- $this->set_prop( 'discount_tax', wc_format_decimal( $value ) );
- }
- /**
- * Set shipping_total.
- *
- * @param string $value
- * @throws WC_Data_Exception
- */
- public function set_shipping_total( $value ) {
- $this->set_prop( 'shipping_total', wc_format_decimal( $value ) );
- }
- /**
- * Set shipping_tax.
- *
- * @param string $value
- * @throws WC_Data_Exception
- */
- public function set_shipping_tax( $value ) {
- $this->set_prop( 'shipping_tax', wc_format_decimal( $value ) );
- $this->set_total_tax( (float) $this->get_cart_tax() + (float) $this->get_shipping_tax() );
- }
- /**
- * Set cart tax.
- *
- * @param string $value
- * @throws WC_Data_Exception
- */
- public function set_cart_tax( $value ) {
- $this->set_prop( 'cart_tax', wc_format_decimal( $value ) );
- $this->set_total_tax( (float) $this->get_cart_tax() + (float) $this->get_shipping_tax() );
- }
- /**
- * Sets order tax (sum of cart and shipping tax). Used internaly only.
- *
- * @param string $value
- * @throws WC_Data_Exception
- */
- protected function set_total_tax( $value ) {
- $this->set_prop( 'total_tax', wc_format_decimal( $value ) );
- }
- /**
- * Set total.
- *
- * @param string $value
- * @param string $deprecated Function used to set different totals based on this.
- * @throws WC_Data_Exception
- */
- public function set_total( $value, $deprecated = '' ) {
- if ( $deprecated ) {
- wc_deprecated_argument( 'total_type', '3.0', 'Use dedicated total setter methods instead.' );
- return $this->legacy_set_total( $value, $deprecated );
- }
- $this->set_prop( 'total', wc_format_decimal( $value, wc_get_price_decimals() ) );
- }
- /**
- |--------------------------------------------------------------------------
- | Order Item Handling
- |--------------------------------------------------------------------------
- |
- | Order items are used for products, taxes, shipping, and fees within
- | each order.
- */
- /**
- * Remove all line items (products, coupons, shipping, taxes) from the order.
- *
- * @param string $type Order item type. Default null.
- */
- public function remove_order_items( $type = null ) {
- if ( ! empty( $type ) ) {
- $this->data_store->delete_items( $this, $type );
- if ( $group = $this->type_to_group( $type ) ) {
- unset( $this->items[ $group ] );
- }
- } else {
- $this->data_store->delete_items( $this );
- $this->items = array();
- }
- }
- /**
- * Convert a type to a types group.
- *
- * @param string $type
- * @return string group
- */
- protected function type_to_group( $type ) {
- $type_to_group = apply_filters( 'woocommerce_order_type_to_group', array(
- 'line_item' => 'line_items',
- 'tax' => 'tax_lines',
- 'shipping' => 'shipping_lines',
- 'fee' => 'fee_lines',
- 'coupon' => 'coupon_lines',
- ) );
- return isset( $type_to_group[ $type ] ) ? $type_to_group[ $type ] : '';
- }
- /**
- * Return an array of items/products within this order.
- *
- * @param string|array $types Types of line items to get (array or string).
- * @return Array of WC_Order_item
- */
- public function get_items( $types = 'line_item' ) {
- $items = array();
- $types = array_filter( (array) $types );
- foreach ( $types as $type ) {
- if ( $group = $this->type_to_group( $type ) ) {
- if ( ! isset( $this->items[ $group ] ) ) {
- $this->items[ $group ] = $this->data_store->read_items( $this, $type );
- }
- // Don't use array_merge here because keys are numeric
- $items = array_filter( $items + $this->items[ $group ] );
- }
- }
- return apply_filters( 'woocommerce_order_get_items', $items, $this );
- }
- /**
- * Return an array of fees within this order.
- *
- * @return array
- */
- public function get_fees() {
- return $this->get_items( 'fee' );
- }
- /**
- * Return an array of taxes within this order.
- *
- * @return array
- */
- public function get_taxes() {
- return $this->get_items( 'tax' );
- }
- /**
- * Return an array of shipping costs within this order.
- *
- * @return array
- */
- public function get_shipping_methods() {
- return $this->get_items( 'shipping' );
- }
- /**
- * Gets formatted shipping method title.
- *
- * @return string
- */
- public function get_shipping_method() {
- $names = array();
- foreach ( $this->get_shipping_methods() as $shipping_method ) {
- $names[] = $shipping_method->get_name();
- }
- return apply_filters( 'woocommerce_order_shipping_method', implode( ', ', $names ), $this );
- }
- /**
- * Get coupon codes only.
- *
- * @return array
- */
- public function get_used_coupons() {
- $coupon_codes = array();
- if ( $coupons = $this->get_items( 'coupon' ) ) {
- foreach ( $coupons as $coupon ) {
- $coupon_codes[] = $coupon->get_code();
- }
- }
- return $coupon_codes;
- }
- /**
- * Gets the count of order items of a certain type.
- *
- * @param string $item_type
- * @return string
- */
- public function get_item_count( $item_type = '' ) {
- $items = $this->get_items( empty( $item_type ) ? 'line_item' : $item_type );
- $count = 0;
- foreach ( $items as $item ) {
- $count += $item->get_quantity();
- }
- return apply_filters( 'woocommerce_get_item_count', $count, $item_type, $this );
- }
- /**
- * Get an order item object, based on it's type.
- *
- * @since 3.0.0
- * @param int $item_id
- * @return WC_Order_Item
- */
- public function get_item( $item_id ) {
- return WC_Order_Factory::get_order_item( $item_id );
- }
- /**
- * Get key for where a certain item type is stored in _items.
- *
- * @since 3.0.0
- * @param $item object Order item (product, shipping, fee, coupon, tax)
- * @return string
- */
- protected function get_items_key( $item ) {
- if ( is_a( $item, 'WC_Order_Item_Product' ) ) {
- return 'line_items';
- } elseif ( is_a( $item, 'WC_Order_Item_Fee' ) ) {
- return 'fee_lines';
- } elseif ( is_a( $item, 'WC_Order_Item_Shipping' ) ) {
- return 'shipping_lines';
- } elseif ( is_a( $item, 'WC_Order_Item_Tax' ) ) {
- return 'tax_lines';
- } elseif ( is_a( $item, 'WC_Order_Item_Coupon' ) ) {
- return 'coupon_lines';
- } else {
- return '';
- }
- }
- /**
- * Remove item from the order.
- *
- * @param int $item_id
- */
- public function remove_item( $item_id ) {
- $item = $this->get_item( $item_id );
- if ( ! $item || ! ( $items_key = $this->get_items_key( $item ) ) ) {
- return false;
- }
- // Unset and remove later
- $this->items_to_delete[] = $item;
- unset( $this->items[ $items_key ][ $item->get_id() ] );
- }
- /**
- * Adds an order item to this order. The order item will not persist until save.
- *
- * @since 3.0.0
- * @param WC_Order_Item Order item object (product, shipping, fee, coupon, tax)
- */
- public function add_item( $item ) {
- if ( ! $items_key = $this->get_items_key( $item ) ) {
- return false;
- }
- // Make sure existing items are loaded so we can append this new one.
- if ( ! isset( $this->items[ $items_key ] ) ) {
- $this->items[ $items_key ] = $this->get_items( $item->get_type() );
- }
- // Set parent.
- $item->set_order_id( $this->get_id() );
- // Append new row with generated temporary ID
- if ( $item_id = $item->get_id() ) {
- $this->items[ $items_key ][ $item_id ] = $item;
- } else {
- $this->items[ $items_key ][ 'new:' . $items_key . sizeof( $this->items[ $items_key ] ) ] = $item;
- }
- }
- /**
- * Add a product line item to the order. This is the only line item type with
- * it's own method because it saves looking up order amounts (costs are added up for you).
- *
- * @param \WC_Product $product
- * @param int $qty
- * @param array $args
- * @return int order item ID
- * @throws WC_Data_Exception
- */
- public function add_product( $product, $qty = 1, $args = array() ) {
- if ( $product ) {
- $default_args = array(
- 'name' => $product->get_name(),
- 'tax_class' => $product->get_tax_class(),
- 'product_id' => $product->is_type( 'variation' ) ? $product->get_parent_id() : $product->get_id(),
- 'variation_id' => $product->is_type( 'variation' ) ? $product->get_id() : 0,
- 'variation' => $product->is_type( 'variation' ) ? $product->get_attributes() : array(),
- 'subtotal' => wc_get_price_excluding_tax( $product, array( 'qty' => $qty ) ),
- 'total' => wc_get_price_excluding_tax( $product, array( 'qty' => $qty ) ),
- 'quantity' => $qty,
- );
- } else {
- $default_args = array(
- 'quantity' => $qty,
- );
- }
- $args = wp_parse_args( $args, $default_args );
- // BW compatibility with old args
- if ( isset( $args['totals'] ) ) {
- foreach ( $args['totals'] as $key => $value ) {
- if ( 'tax' === $key ) {
- $args['total_tax'] = $value;
- } elseif ( 'tax_data' === $key ) {
- $args['taxes'] = $value;
- } else {
- $args[ $key ] = $value;
- }
- }
- }
- $item = new WC_Order_Item_Product();
- $item->set_props( $args );
- $item->set_backorder_meta();
- $item->set_order_id( $this->get_id() );
- $item->save();
- $this->add_item( $item );
- wc_do_deprecated_action( 'woocommerce_order_add_product', array( $this->get_id(), $item->get_id(), $product, $qty, $args ), '3.0', 'woocommerce_new_order_item action instead' );
- return $item->get_id();
- }
- /**
- |--------------------------------------------------------------------------
- | Payment Token Handling
- |--------------------------------------------------------------------------
- |
- | Payment tokens are hashes used to take payments by certain gateways.
- |
- */
- /**
- * Add a payment token to an order
- *
- * @since 2.6
- * @param WC_Payment_Token $token Payment token object
- * @return boolean|int The new token ID or false if it failed.
- */
- public function add_payment_token( $token ) {
- if ( empty( $token ) || ! ( $token instanceof WC_Payment_Token ) ) {
- return false;
- }
- $token_ids = $this->data_store->get_payment_token_ids( $this );
- $token_ids[] = $token->get_id();
- $this->data_store->update_payment_token_ids( $this, $token_ids );
- do_action( 'woocommerce_payment_token_added_to_order', $this->get_id(), $token->get_id(), $token, $token_ids );
- return $token->get_id();
- }
- /**
- * Returns a list of all payment tokens associated with the current order
- *
- * @since 2.6
- * @return array An array of payment token objects
- */
- public function get_payment_tokens() {
- return $this->data_store->get_payment_token_ids( $this );
- }
- /**
- |--------------------------------------------------------------------------
- | Calculations.
- |--------------------------------------------------------------------------
- |
- | These methods calculate order totals and taxes based on the current data.
- |
- */
- /**
- * Calculate shipping total.
- *
- * @since 2.2
- * @return float
- */
- public function calculate_shipping() {
- $shipping_total = 0;
- foreach ( $this->get_shipping_methods() as $shipping ) {
- $shipping_total += $shipping->get_total();
- }
- $this->set_shipping_total( $shipping_total );
- $this->save();
- return $this->get_shipping_total();
- }
- /**
- * Get all tax classes for items in the order.
- *
- * @since 2.6.3
- * @return array
- */
- public function get_items_tax_classes() {
- $found_tax_classes = array();
- foreach ( $this->get_items() as $item ) {
- if ( $_product = $item->get_product() ) {
- $found_tax_classes[] = $_product->get_tax_class();
- }
- }
- return array_unique( $found_tax_classes );
- }
- /**
- * Calculate taxes for all line items and shipping, and store the totals and tax rows.
- *
- * Will use the base country unless customer addresses are set.
- * @param $args array Added in 3.0.0 to pass things like location.
- */
- public function calculate_taxes( $args = array() ) {
- $tax_based_on = get_option( 'woocommerce_tax_based_on' );
- $args = wp_parse_args( $args, array(
- 'country' => 'billing' === $tax_based_on ? $this->get_billing_country() : $this->get_shipping_country(),
- 'state' => 'billing' === $tax_based_on ? $this->get_billing_state() : $this->get_shipping_state(),
- 'postcode' => 'billing' === $tax_based_on ? $this->get_billing_postcode() : $this->get_shipping_postcode(),
- 'city' => 'billing' === $tax_based_on ? $this->get_billing_city() : $this->get_shipping_city(),
- ) );
- // Default to base
- if ( 'base' === $tax_based_on || empty( $args['country'] ) ) {
- $default = wc_get_base_location();
- $args['country'] = $default['country'];
- $args['state'] = $default['state'];
- $args['postcode'] = '';
- $args['city'] = '';
- }
- // Calc taxes for line items
- foreach ( $this->get_items( array( 'line_item', 'fee' ) ) as $item_id => $item ) {
- $tax_class = $item->get_tax_class();
- $tax_status = $item->get_tax_status();
- if ( '0' !== $tax_class && 'taxable' === $tax_status ) {
- $tax_rates = WC_Tax::find_rates( array(
- 'country' => $args['country'],
- 'state' => $args['state'],
- 'postcode' => $args['postcode'],
- 'city' => $args['city'],
- 'tax_class' => $tax_class,
- ) );
- $total = $item->get_total();
- $taxes = WC_Tax::calc_tax( $total, $tax_rates, false );
- if ( $item->is_type( 'line_item' ) ) {
- $subtotal = $item->get_subtotal();
- $subtotal_taxes = WC_Tax::calc_tax( $subtotal, $tax_rates, false );
- $item->set_taxes( array( 'total' => $taxes, 'subtotal' => $subtotal_taxes ) );
- } else {
- $item->set_taxes( array( 'total' => $taxes ) );
- }
- $item->save();
- }
- }
- // Calc taxes for shipping
- foreach ( $this->get_shipping_methods() as $item_id => $item ) {
- $shipping_tax_class = get_option( 'woocommerce_shipping_tax_class' );
- // Inherit tax class from items
- if ( 'inherit' === $shipping_tax_class ) {
- $tax_rates = array();
- $tax_classes = array_merge( array( '' ), WC_Tax::get_tax_class_slugs() );
- $found_tax_classes = $this->get_items_tax_classes();
- foreach ( $tax_classes as $tax_class ) {
- if ( in_array( $tax_class, $found_tax_classes ) ) {
- $tax_rates = WC_Tax::find_shipping_rates( array(
- 'country' => $args['country'],
- 'state' => $args['state'],
- 'postcode' => $args['postcode'],
- 'city' => $args['city'],
- 'tax_class' => $tax_class,
- ) );
- break;
- }
- }
- } else {
- $tax_rates = WC_Tax::find_shipping_rates( array(
- 'country' => $args['country'],
- 'state' => $args['state'],
- 'postcode' => $args['postcode'],
- 'city' => $args['city'],
- 'tax_class' => $shipping_tax_class,
- ) );
- }
- $item->set_taxes( array( 'total' => WC_Tax::calc_tax( $item->get_total(), $tax_rates, false ) ) );
- $item->save();
- }
- $this->update_taxes();
- }
- /**
- * Update tax lines for the order based on the line item taxes themselves.
- */
- public function update_taxes() {
- $cart_taxes = array();
- $shipping_taxes = array();
- $existing_taxes = $this->get_taxes();
- $saved_rate_ids = array();
- foreach ( $this->get_items( array( 'line_item', 'fee' ) ) as $item_id => $item ) {
- $taxes = $item->get_taxes();
- foreach ( $taxes['total'] as $tax_rate_id => $tax ) {
- $cart_taxes[ $tax_rate_id ] = isset( $cart_taxes[ $tax_rate_id ] ) ? $cart_taxes[ $tax_rate_id ] + (float) $tax : (float) $tax;
- }
- }
- foreach ( $this->get_shipping_methods() as $item_id => $item ) {
- $taxes = $item->get_taxes();
- foreach ( $taxes['total'] as $tax_rate_id => $tax ) {
- $shipping_taxes[ $tax_rate_id ] = isset( $shipping_taxes[ $tax_rate_id ] ) ? $shipping_taxes[ $tax_rate_id ] + (float) $tax : (float) $tax;
- }
- }
- foreach ( $existing_taxes as $tax ) {
- // Remove taxes which no longer exist for cart/shipping.
- if ( ( ! array_key_exists( $tax->get_rate_id(), $cart_taxes ) && ! array_key_exists( $tax->get_rate_id(), $shipping_taxes ) ) || in_array( $tax->get_rate_id(), $saved_rate_ids ) ) {
- $this->remove_item( $tax->get_id() );
- continue;
- }
- $saved_rate_ids[] = $tax->get_rate_id();
- $tax->set_tax_total( isset( $cart_taxes[ $tax->get_rate_id() ] ) ? $cart_taxes[ $tax->get_rate_id() ] : 0 );
- $tax->set_shipping_tax_total( ! empty( $shipping_taxes[ $tax->get_rate_id() ] ) ? $shipping_taxes[ $tax->get_rate_id() ] : 0 );
- $tax->save();
- }
- $new_rate_ids = wp_parse_id_list( array_diff( array_keys( $cart_taxes + $shipping_taxes ), $saved_rate_ids ) );
- // New taxes.
- foreach ( $new_rate_ids as $tax_rate_id ) {
- $item = new WC_Order_Item_Tax();
- $item->set_rate( $tax_rate_id );
- $item->set_tax_total( isset( $cart_taxes[ $tax_rate_id ] ) ? $cart_taxes[ $tax_rate_id ] : 0 );
- $item->set_shipping_tax_total( ! empty( $shipping_taxes[ $tax_rate_id ] ) ? $shipping_taxes[ $tax_rate_id ] : 0 );
- $this->add_item( $item );
- }
- // Save tax totals
- $this->set_shipping_tax( WC_Tax::round( array_sum( $shipping_taxes ) ) );
- $this->set_cart_tax( WC_Tax::round( array_sum( $cart_taxes ) ) );
- $this->save();
- }
- /**
- * Calculate totals by looking at the contents of the order. Stores the totals and returns the orders final total.
- *
- * @since 2.2
- * @param bool $and_taxes Calc taxes if true.
- * @return float calculated grand total.
- */
- public function calculate_totals( $and_taxes = true ) {
- $cart_subtotal = 0;
- $cart_total = 0;
- $fee_total = 0;
- $cart_subtotal_tax = 0;
- $cart_total_tax = 0;
- if ( $and_taxes && wc_tax_enabled() ) {
- $this->calculate_taxes();
- }
- // line items
- foreach ( $this->get_items() as $item ) {
- $cart_subtotal += $item->get_subtotal();
- $cart_total += $item->get_total();
- $cart_subtotal_tax += $item->get_subtotal_tax();
- $cart_total_tax += $item->get_total_tax();
- }
- $this->calculate_shipping();
- foreach ( $this->get_fees() as $item ) {
- $fee_total += $item->get_total();
- }
- $grand_total = round( $cart_total + $fee_total + $this->get_shipping_total() + $this->get_cart_tax() + $this->get_shipping_tax(), wc_get_price_decimals() );
- $this->set_discount_total( $cart_subtotal - $cart_total );
- $this->set_discount_tax( $cart_subtotal_tax - $cart_total_tax );
- $this->set_total( $grand_total );
- $this->save();
- return $grand_total;
- }
- /**
- * Get item subtotal - this is the cost before discount.
- *
- * @param object $item
- * @param bool $inc_tax (default: false).
- * @param bool $round (default: true).
- * @return float
- */
- public function get_item_subtotal( $item, $inc_tax = false, $round = true ) {
- $subtotal = 0;
- if ( is_callable( array( $item, 'get_subtotal' ) ) ) {
- if ( $inc_tax ) {
- $subtotal = ( $item->get_subtotal() + $item->get_subtotal_tax() ) / max( 1, $item->get_quantity() );
- } else {
- $subtotal = ( floatval( $item->get_subtotal() ) / max( 1, $item->get_quantity() ) );
- }
- $subtotal = $round ? number_format( (float) $subtotal, wc_get_price_decimals(), '.', '' ) : $subtotal;
- }
- return apply_filters( 'woocommerce_order_amount_item_subtotal', $subtotal, $this, $item, $inc_tax, $round );
- }
- /**
- * Get line subtotal - this is the cost before discount.
- *
- * @param object $item
- * @param bool $inc_tax (default: false).
- * @param bool $round (default: true).
- * @return float
- */
- public function get_line_subtotal( $item, $inc_tax = false, $round = true ) {
- $subtotal = 0;
- if ( is_callable( array( $item, 'get_subtotal' ) ) ) {
- if ( $inc_tax ) {
- $subtotal = $item->get_subtotal() + $item->get_subtotal_tax();
- } else {
- $subtotal = $item->get_subtotal();
- }
- $subtotal = $round ? round( $subtotal, wc_get_price_decimals() ) : $subtotal;
- }
- return apply_filters( 'woocommerce_order_amount_line_subtotal', $subtotal, $this, $item, $inc_tax, $round );
- }
- /**
- * Calculate item cost - useful for gateways.
- *
- * @param object $item
- * @param bool $inc_tax (default: false).
- * @param bool $round (default: true).
- * @return float
- */
- public function get_item_total( $item, $inc_tax = false, $round = true ) {
- $total = 0;
- if ( is_callable( array( $item, 'get_total' ) ) ) {
- if ( $inc_tax ) {
- $total = ( $item->get_total() + $item->get_total_tax() ) / max( 1, $item->get_quantity() );
- } else {
- $total = floatval( $item->get_total() ) / max( 1, $item->get_quantity() );
- }
- $total = $round ? round( $total, wc_get_price_decimals() ) : $total;
- }
- return apply_filters( 'woocommerce_order_amount_item_total', $total, $this, $item, $inc_tax, $round );
- }
- /**
- * Calculate line total - useful for gateways.
- *
- * @param object $item
- * @param bool $inc_tax (default: false).
- * @param bool $round (default: true).
- * @return float
- */
- public function get_line_total( $item, $inc_tax = false, $round = true ) {
- $total = 0;
- if ( is_callable( array( $item, 'get_total' ) ) ) {
- // Check if we need to add line tax to the line total.
- $total = $inc_tax ? $item->get_total() + $item->get_total_tax() : $item->get_total();
- // Check if we need to round.
- $total = $round ? round( $total, wc_get_price_decimals() ) : $total;
- }
- return apply_filters( 'woocommerce_order_amount_line_total', $total, $this, $item, $inc_tax, $round );
- }
- /**
- * Get item tax - useful for gateways.
- *
- * @param mixed $item
- * @param bool $round (default: true).
- * @return float
- */
- public function get_item_tax( $item, $round = true ) {
- $tax = 0;
- if ( is_callable( array( $item, 'get_total_tax' ) ) ) {
- $tax = $item->get_total_tax() / max( 1, $item->get_quantity() );
- $tax = $round ? wc_round_tax_total( $tax ) : $tax;
- }
- return apply_filters( 'woocommerce_order_amount_item_tax', $tax, $item, $round, $this );
- }
- /**
- * Get line tax - useful for gateways.
- *
- * @param mixed $item
- * @return float
- */
- public function get_line_tax( $item ) {
- return apply_filters( 'woocommerce_order_amount_line_tax', is_callable( array( $item, 'get_total_tax' ) ) ? wc_round_tax_total( $item->get_total_tax() ) : 0, $item, $this );
- }
- /**
- * Gets line subtotal - formatted for display.
- *
- * @param array $item
- * @param string $tax_display
- * @return string
- */
- public function get_formatted_line_subtotal( $item, $tax_display = '' ) {
- $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' );
- if ( 'excl' == $tax_display ) {
- $ex_tax_label = $this->get_prices_include_tax() ? 1 : 0;
- $subtotal = wc_price( $this->get_line_subtotal( $item ), array( 'ex_tax_label' => $ex_tax_label, 'currency' => $this->get_currency() ) );
- } else {
- $subtotal = wc_price( $this->get_line_subtotal( $item, true ), array( 'currency' => $this->get_currency() ) );
- }
- return apply_filters( 'woocommerce_order_formatted_line_subtotal', $subtotal, $item, $this );
- }
- /**
- * Gets order total - formatted for display.
- * @return string
- */
- public function get_formatted_order_total() {
- $formatted_total = wc_price( $this->get_total(), array( 'currency' => $this->get_currency() ) );
- return apply_filters( 'woocommerce_get_formatted_order_total', $formatted_total, $this );
- }
- /**
- * Gets subtotal - subtotal is shown before discounts, but with localised taxes.
- *
- * @param bool $compound (default: false).
- * @param string $tax_display (default: the tax_display_cart value).
- * @return string
- */
- public function get_subtotal_to_display( $compound = false, $tax_display = '' ) {
- $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' );
- $subtotal = 0;
- if ( ! $compound ) {
- foreach ( $this->get_items() as $item ) {
- $subtotal += $item->get_subtotal();
- if ( 'incl' === $tax_display ) {
- $subtotal += $item->get_subtotal_tax();
- }
- }
- $subtotal = wc_price( $subtotal, array( 'currency' => $this->get_currency() ) );
- if ( 'excl' === $tax_display && $this->get_prices_include_tax() ) {
- $subtotal .= ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>';
- }
- } else {
- if ( 'incl' === $tax_display ) {
- return '';
- }
- foreach ( $this->get_items() as $item ) {
- $subtotal += $item->get_subtotal();
- }
- // Add Shipping Costs.
- $subtotal += $this->get_shipping_total();
- // Remove non-compound taxes.
- foreach ( $this->get_taxes() as $tax ) {
- if ( $tax->is_compound() ) {
- continue;
- }
- $subtotal = $subtotal + $tax->get_tax_total() + $tax->get_shipping_tax_total();
- }
- // Remove discounts.
- $subtotal = $subtotal - $this->get_total_discount();
- $subtotal = wc_price( $subtotal, array( 'currency' => $this->get_currency() ) );
- }
- return apply_filters( 'woocommerce_order_subtotal_to_display', $subtotal, $compound, $this );
- }
- /**
- * Gets shipping (formatted).
- *
- * @return string
- */
- public function get_shipping_to_display( $tax_display = '' ) {
- $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' );
- if ( $this->get_shipping_total() != 0 ) {
- if ( 'excl' === $tax_display ) {
- // Show shipping excluding tax.
- $shipping = wc_price( $this->get_shipping_total(), array( 'currency' => $this->get_currency() ) );
- if ( $this->get_shipping_tax() != 0 && $this->get_prices_include_tax() ) {
- $shipping .= apply_filters( 'woocommerce_order_shipping_to_display_tax_label', ' <small class="tax_label">' . WC()->countries->ex_tax_or_vat() . '</small>', $this, $tax_display );
- }
- } else {
- // Show shipping including tax.
- $shipping = wc_price( $this->get_shipping_total() + $this->get_shipping_tax(), array( 'currency' => $this->get_currency() ) );
- if ( $this->get_shipping_tax() != 0 && ! $this->get_prices_include_tax() ) {
- $shipping .= apply_filters( 'woocommerce_order_shipping_to_display_tax_label', ' <small class="tax_label">' . WC()->countries->inc_tax_or_vat() . '</small>', $this, $tax_display );
- }
- }
- /** translators: %s: shipping method */
- $shipping .= apply_filters( 'woocommerce_order_shipping_to_display_shipped_via', ' <small class="shipped_via">' . sprintf( __( 'via %s', 'woocommerce' ), $this->get_shipping_method() ) . '</small>', $this );
- } elseif ( $this->get_shipping_method() ) {
- $shipping = $this->get_shipping_method();
- } else {
- $shipping = __( 'Free!', 'woocommerce' );
- }
- return apply_filters( 'woocommerce_order_shipping_to_display', $shipping, $this );
- }
- /**
- * Get the discount amount (formatted).
- * @since 2.3.0
- * @return string
- */
- public function get_discount_to_display( $tax_display = '' ) {
- $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' );
- return apply_filters( 'woocommerce_order_discount_to_display', wc_price( $this->get_total_discount( 'excl' === $tax_display && 'excl' === get_option( 'woocommerce_tax_display_cart' ) ), array( 'currency' => $this->get_currency() ) ), $this );
- }
- /**
- * Add total row for subtotal.
- *
- * @param array $total_rows
- * @param string $tax_display
- */
- protected function add_order_item_totals_subtotal_row( &$total_rows, $tax_display ) {
- if ( $subtotal = $this->get_subtotal_to_display( false, $tax_display ) ) {
- $total_rows['cart_subtotal'] = array(
- 'label' => __( 'Subtotal:', 'woocommerce' ),
- 'value' => $subtotal,
- );
- }
- }
- /**
- * Add total row for discounts.
- *
- * @param array $total_rows
- * @param string $tax_display
- */
- protected function add_order_item_totals_discount_row( &$total_rows, $tax_display ) {
- if ( $this->get_total_discount() > 0 ) {
- $total_rows['discount'] = array(
- 'label' => __( 'Discount:', 'woocommerce' ),
- 'value' => '-' . $this->get_discount_to_display( $tax_display ),
- );
- }
- }
- /**
- * Add total row for shipping.
- *
- * @param array $total_rows
- * @param string $tax_display
- */
- protected function add_order_item_totals_shipping_row( &$total_rows, $tax_display ) {
- if ( $this->get_shipping_method() ) {
- $total_rows['shipping'] = array(
- 'label' => __( 'Shipping:', 'woocommerce' ),
- 'value' => $this->get_shipping_to_display( $tax_display ),
- );
- }
- }
- /**
- * Add total row for fees.
- *
- * @param array $total_rows
- * @param string $tax_display
- */
- protected function add_order_item_totals_fee_rows( &$total_rows, $tax_display ) {
- if ( $fees = $this->get_fees() ) {
- foreach ( $fees as $id => $fee ) {
- if ( apply_filters( 'woocommerce_get_order_item_totals_excl_free_fees', empty( $fee['line_total'] ) && empty( $fee['line_tax'] ), $id ) ) {
- continue;
- }
- $total_rows[ 'fee_' . $fee->get_id() ] = array(
- 'label' => $fee->get_name() . ':',
- 'value' => wc_price( 'excl' === $tax_display ? $fee->get_total() : $fee->get_total() + $fee->get_total_tax(), array( 'currency' => $this->get_currency() ) ),
- );
- }
- }
- }
- /**
- * Add total row for taxes.
- *
- * @param array $total_rows
- * @param string $tax_display
- */
- protected function add_order_item_totals_tax_rows( &$total_rows, $tax_display ) {
- // Tax for tax exclusive prices.
- if ( 'excl' === $tax_display ) {
- if ( 'itemized' === get_option( 'woocommerce_tax_total_display' ) ) {
- foreach ( $this->get_tax_totals() as $code => $tax ) {
- $total_rows[ sanitize_title( $code ) ] = array(
- 'label' => $tax->label . ':',
- 'value' => $tax->formatted_amount,
- );
- }
- } else {
- $total_rows['tax'] = array(
- 'label' => WC()->countries->tax_or_vat() . ':',
- 'value' => wc_price( $this->get_total_tax(), array( 'currency' => $this->get_currency() ) ),
- );
- }
- }
- }
- /**
- * Add total row for grand total.
- *
- * @param array $total_rows
- * @param string $tax_display
- */
- protected function add_order_item_totals_total_row( &$total_rows, $tax_display ) {
- $total_rows['order_total'] = array(
- 'label' => __( 'Total:', 'woocommerce' ),
- 'value' => $this->get_formatted_order_total( $tax_display ),
- );
- }
- /**
- * Get totals for display on pages and in emails.
- *
- * @param mixed $tax_display
- * @return array
- */
- public function get_order_item_totals( $tax_display = '' ) {
- $tax_display = $tax_display ? $tax_display : get_option( 'woocommerce_tax_display_cart' );
- $total_rows = array();
- $this->add_order_item_totals_subtotal_row( $total_rows, $tax_display );
- $this->add_order_item_totals_discount_row( $total_rows, $tax_display );
- $this->add_order_item_totals_shipping_row( $total_rows, $tax_display );
- $this->add_order_item_totals_fee_rows( $total_rows, $tax_display );
- $this->add_order_item_totals_tax_rows( $total_rows, $tax_display );
- $this->add_order_item_totals_total_row( $total_rows, $tax_display );
- return apply_filters( 'woocommerce_get_order_item_totals', $total_rows, $this, $tax_display );
- }
- /**
- |--------------------------------------------------------------------------
- | Conditionals
- |--------------------------------------------------------------------------
- |
- | Checks if a condition is true or false.
- |
- */
- /**
- * Checks the order status against a passed in status.
- *
- * @return bool
- */
- public function has_status( $status ) {
- return apply_filters( 'woocommerce_order_has_status', ( is_array( $status ) && in_array( $this->get_status(), $status ) ) || $this->get_status() === $status ? true : false, $this, $status );
- }
- /**
- * Check whether this order has a specific shipping method or not.
- *
- * @param string $method_id
- * @return bool
- */
- public function has_shipping_method( $method_id ) {
- foreach ( $this->get_shipping_methods() as $shipping_method ) {
- if ( strpos( $shipping_method->get_method_id(), $method_id ) === 0 ) {
- return true;
- }
- }
- return false;
- }
- /**
- * Returns true if the order contains a free product.
- * @since 2.5.0
- * @return bool
- */
- public function has_free_item() {
- foreach ( $this->get_items() as $item ) {
- if ( ! $item->get_total() ) {
- return true;
- }
- }
- return false;
- }
- }