woocommerce_order_item_cogs_refunded_html
Filter to customize the refunded Cost of Goods Sold (COGS) value HTML for a given order item.
Usage
add_filter( 'woocommerce_order_item_cogs_refunded_html', 'wp_kama_woocommerce_order_item_cogs_refunded_html_filter', 10, 4 );
/**
* Function for `woocommerce_order_item_cogs_refunded_html` filter-hook.
*
* @param string $refunded_html The formatted refunded COGS HTML.
* @param float $refunded_cost The refunded cost value (always zero or a negative number).
* @param WC_Order_Item $item The order item object.
* @param WC_Order $order The order object.
*
* @return string
*/
function wp_kama_woocommerce_order_item_cogs_refunded_html_filter( $refunded_html, $refunded_cost, $item, $order ){
// filter...
return $refunded_html;
}
- $refunded_html(string)
- The formatted refunded COGS HTML.
- $refunded_cost(float)
- The refunded cost value (always zero or a negative number).
- $item(WC_Order_Item)
- The order item object.
- $order(WC_Order)
- The order object.
Changelog
| Since 10.3.0 | Introduced. |
Where the hook is called
woocommerce_order_item_cogs_refunded_html
woocommerce/includes/class-wc-order-item.php 665
return apply_filters( 'woocommerce_order_item_cogs_refunded_html', $html, $refunded_cost, $this, $order );