Displays the total tax assessed for the cart in the store’s default currency.

shopp('cart', 'tax', 'options')

@param string $object the object or object.tag combination, if object.tag is used, the tag parameter can be omitted
@param string $tag the tag, can be hyphenated or not. Prefix with 'get' as shorthand for the return=true option
@param mixed $options associative array, or url-style name=value pairs separated by ampersands (&). Each pair is passed to the theme api tag as an option.
@returns void by default, the total estimated tax cost when the return option is used.

Alternative Forms

shopp('', 'options');


Displays the current total tax cost estimate, or a user specified label.


The following options are valid.

  • label: a string to be used instead of the current tax cost.

Universal Options

All Theme API calls have these options.

  • return: when set to true, 1, or on, this option forces the tag to return the value instead of displaying/echoing the value to the page. Alternatively, prefix the tag parameter with get to get the same effect. All theme api tags that return a boolean value will return by default.
  • echo: when set to false, 0, or off, this option forces the tag to display the value to the page. This is the default for all non-boolean tags.
  • is: when set to true, 1, or on, this option will evaluate the return of the theme api call as a boolean true or false value. See how values are converted to boolean.


shopp('cart', 'tax', 'options...');
// Always displays "Tax TBD"
shopp('cart', 'tax', 'label=Tax TBD');
// Assign the current total tax estimate to a variable
$tax = shopp('cart', 'get-tax');

See Also

  1. Use option “number=on” to return the number without any formatting if you need use the value with math operators.

    November 10th   #

You must be logged in to post a comment.

© Ingenesis Limited. Shopp™ is a registered trademark of Ingenesis Limited.