shopp('cart.shipping-estimates')

Displays a set of inputs for getting shipping estimates in the cart, by allowing the customer to set basic address information.

shopp('cart', 'shipping-estimates', '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 shipping estimates menus markup when return option is set.

Alternative Forms

shopp('cart.shipping-estimates', 'options');

Description

Displays a set of inputs for getting shipping estimates in the cart, by allowing the customer to set basic address information.

When there is more than one target country in your Shopp settings, this will also display a country drop-down menu. By default, Shopp javascript updates the cart totals when the shipping country is changed in this drop down menu. When only one target country exists, a hidden input pre-setting the target country is added to the cart.

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.

Options

The following options are valid.

  • class: (Default ship-estimates) Used to set the class attribute for the wrapping <div> around the set of shipping estimate inputs.
  • postcode: (Default true) When set to true,on,1, forces a postal code input and submit button to appear with the shipping-estimates menu set. When set to false,off,0, the postal code input and update submit button is not displayed, unless an online shipping module (such as FedEx,UPS,USPS,Canada Post) is enabled.
  • label: (Default: Estimate Shipping & Taxes) Sets the button text label.

Examples

shopp('cart', 'shipping-estimates');

Force postal code selector, and set a class attribute to the wrapping div

shopp('cart.shipping-estimates',array('postcode'=>true, 'class'=>'ship-estimates'));

See Also

You must be logged in to post a comment.

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

Skip to toolbar