Automattic\WooCommerce\Internal\DataStores\Orders

OrdersTableDataStore::get_total_shipping_tax_refunded │ public │ WC 10.2.0

Get the total shipping tax refunded.

Method of the class: OrdersTableDataStore{}

No Hooks.

Returns

float.

Usage

$OrdersTableDataStore = new OrdersTableDataStore();
$OrdersTableDataStore->get_total_shipping_tax_refunded( $order );

$order(WC_Order) (required)

Order object.

Changelog

OrdersTableDataStore::get_total_shipping_tax_refunded() OrdersTableDataStore::get total shipping tax refunded code ^{WC 10.3.3}

public function get_total_shipping_tax_refunded( $order ) {
	global $wpdb;

	$order_table = self::get_orders_table_name();

	$total = $wpdb->get_var(
		// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $order_table is hardcoded.
		$wpdb->prepare(
			"SELECT SUM( order_itemmeta.meta_value )
			FROM {$wpdb->prefix}woocommerce_order_itemmeta AS order_itemmeta
			INNER JOIN $order_table AS orders ON ( orders.type = 'shop_order_refund' AND orders.parent_order_id = %d )
			INNER JOIN {$wpdb->prefix}woocommerce_order_items AS order_items ON ( order_items.order_id = orders.id AND order_items.order_item_type = 'tax' )
			WHERE order_itemmeta.order_item_id = order_items.order_item_id
			AND order_itemmeta.meta_key = 'shipping_tax_amount'",
			$order->get_id()
		)
	) ?? 0;
	// phpcs:enable

	return abs( $total );
}