WC_Order_Item::get_cogs_refund_value_html │ public │ WC 1.0

Returns the refunded Cost of Goods Sold value in html format.

Method of the class: WC_Order_Item{}

Returns

String.

Usage

$WC_Order_Item = new WC_Order_Item();
$WC_Order_Item->get_cogs_refund_value_html( $refunded_cost, ?array $wc_price_arg, ?WC_Order $order ): string;

$refunded_cost(float) (required)

The refunded value.

?array $wc_price_arg

.
Default: null

?WC_Order $order

.
Default: null

WC_Order_Item::get_cogs_refund_value_html() WC Order Item::get cogs refund value html code ^{WC 10.3.3}

public function get_cogs_refund_value_html( float $refunded_cost, ?array $wc_price_arg = null, ?WC_Order $order = null ): string {
	if ( ! $this->cogs_is_enabled( __METHOD__ ) || ! $this->has_cogs() ) {
		return '';
	}

	if ( $refunded_cost > 0 ) {
		$refunded_cost = -$refunded_cost;
	}
	$order ??= $this->get_order();
	$html    = $refunded_cost ? '<small class="refunded">' . wc_price( $refunded_cost, $wc_price_arg ?? array( 'currency' => $order->get_currency() ) ) . '</small>' : '';

	/**
	 * Filter to customize the refunded Cost of Goods Sold (COGS) value HTML for a given order item.
	 *
	 * @since 10.3.0
	 *
	 * @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 apply_filters( 'woocommerce_order_item_cogs_refunded_html', $html, $refunded_cost, $this, $order );
}