LemonStand Documentation

tax_incl_label

function tax_incl_label($order = null)

Returns the tax included label text. Use this function if display prices including tax and you want to let visitors know about it. You can configure the label text and behavior on the System/Settings/eCommerce Settings page:

The function returns the text which you specify in the Tax included label text field in case if the visitor's location matches a country and state specified in the label configuration form. If a visitor's location is not known, the default shipping location is used.

Parameters

• $order - a reference to the Shop_Order class instance. If an order object is available, for example on the Order Details or Receipt pages, pass it to this parameter.

Return value

Returns a string value or NULL.

Examples

The following code outputs a tax included label next to a product price on the product details page:

Price:<?= format_currency($product->price()) ?> <?= tax_incl_label() ?>

Next: Shop_ShippingOption
Previous: Shop_ProductReview
Return to API (function, action and class reference)