WC_Tax::get_rate_label( mixed $key_or_rate )

Return a given rates label.

Contents

Description Description

Parameters Parameters

$key_or_rate

(Required) Tax rate ID, or the db row itself in object format.

Top ↑

Return Return

(string)

Top ↑

Source Source

File: includes/class-wc-tax.php

667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
public static function get_rate_label( $key_or_rate ) {
    global $wpdb;
 
    if ( is_object( $key_or_rate ) ) {
        $key       = $key_or_rate->tax_rate_id;
        $rate_name = $key_or_rate->tax_rate_name;
    } else {
        $key       = $key_or_rate;
        $rate_name = $wpdb->get_var( $wpdb->prepare( "SELECT tax_rate_name FROM {$wpdb->prefix}woocommerce_tax_rates WHERE tax_rate_id = %s", $key ) );
    }
 
    if ( ! $rate_name ) {
        $rate_name = WC()->countries->tax_or_vat();
    }
 
    return apply_filters( 'woocommerce_rate_label', $rate_name, $key );
}

Expand full source code Collapse full source code

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
woocommerce.php: WC()

Returns the main instance of WC.

Top ↑

Used By Used By

Used By
Used By Description
includes/class-wc-order-item-tax.php: WC_Order_Item_Tax::set_rate()

Set properties based on passed in tax rate by ID.
includes/class-wc-cart.php: WC_Cart::get_tax_totals()

Get taxes, merged by code, formatted ready for output.
includes/abstracts/abstract-wc-order.php: WC_Abstract_Order::update_taxes()

Update tax lines for the order based on the line item taxes themselves.
includes/class-wc-checkout.php: WC_Checkout::create_order_tax_lines()

Add tax lines to the order.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.