Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation for two methods in abstract-wc-order.php (#34385) 

* Update abstract-wc-order.php

My attempt to make the documentation clearer for these two methods. It's almost impossible to remember all nuances here, so I constantly find myself testing this. Better to have it in the documentation.

* Changelog.

Co-authored-by: barryhughes <3594411+barryhughes@users.noreply.github.com>
This commit is contained in:
Dekadinious 2022-12-20 02:18:57 +01:00 committed by GitHub
parent 378d5f525e
commit 35f99dba7d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce/changelog/update-order-method-docblocks Normal file
View File

@ -0,0 +1,4 @@
Significance: patch
Type: tweak
Updates and improves the docblocks for methods WC_Order::get_total() and WC_Order::get_subtotal().

6
plugins/woocommerce/includes/abstracts/abstract-wc-order.php
View File

@ -417,7 +417,7 @@ abstract class WC_Abstract_Order extends WC_Abstract_Legacy_Order {
}
/**
* Gets order grand total. incl. taxes. Used in gateways.
* Gets order grand total including taxes, shipping cost, fees, and coupon discounts. Used in gateways.
*
* @param string $context View or edit context.
* @return float
@ -458,7 +458,9 @@ abstract class WC_Abstract_Order extends WC_Abstract_Legacy_Order {
}
/**
* Gets order subtotal.
* Gets order subtotal. Order subtotal is the price of all items excluding taxes, fees, shipping cost, and coupon discounts.
* If sale price is set on an item, the subtotal will include this sale discount. E.g. a product with a regular
* price of $100 bought at a 50% discount will represent $50 of the subtotal for the order.
*
* @return float
*/