woocommerce_save_order_cogs_value
Filter to customize the Cost of Goods Sold value that gets saved for a given order, or to suppress the saving of the value (so that custom storage can be used).
Usage
add_filter( 'woocommerce_save_order_cogs_value', 'wp_kama_woocommerce_save_order_cogs_value_filter', 10, 2 );
/**
* Function for `woocommerce_save_order_cogs_value` filter-hook.
*
* @param float $cogs_value The value to be written to the database. If returned as null, nothing will be written.
* @param WC_Abstract_Order $order The order for which the value is being saved.
*
* @return float
*/
function wp_kama_woocommerce_save_order_cogs_value_filter( $cogs_value, $order ){
// filter...
return $cogs_value;
}
- $cogs_value(float)
- The value to be written to the database. If returned as null, nothing will be written.
- $order(WC_Abstract_Order)
- The order for which the value is being saved.
Changelog
| Since 9.5.0 | Introduced. |
Where the hook is called
woocommerce_save_order_cogs_value
woocommerce_save_order_cogs_value
woocommerce_save_order_cogs_value
woocommerce/src/Internal/DataStores/Orders/OrdersTableDataStore.php 2094
$cogs_value = apply_filters( 'woocommerce_save_order_cogs_value', $cogs_value_original, $order );
woocommerce/includes/data-stores/class-wc-order-data-store-cpt.php 1337
$cogs_value = apply_filters( 'woocommerce_save_order_cogs_value', $cogs_value, $order );
woocommerce/includes/data-stores/class-wc-order-data-store-cpt.php 1397
$value = apply_filters( 'woocommerce_save_order_cogs_value', $value, $order );