shopp('cart.needs-shipping-estimates')

Used to test whether shipping estimates are needed based on your current cart (has physical products that need shipped) and shipping settings (whether shipping cost will vary).

shopp('cart', 'needs-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 boolean True if the order needs shipping estimates calculated

This tag returns a true or false value.

This tag detects if shipping estimates are needed for the shopping cart. Unlike shopp('cart','needs-shipped') which simply detects if shipped items are present in the shopping cart, this tag detects if the shipping system is enabled, there are no free shipping promotions and there are shipped items in the cart.

This is useful for knowing when it is appropriate and necessary to display shipping estimate controls to generate shipping estimates in the shopping cart cart.php content template. See shopp('cart','shipping-estimates').

Options

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.

Examples

<?php if(shopp('cart','needs-shipping-estimates')) { … } ?>

Show shipping estimate controls if shipping is needed

<?php if (shopp('cart','needs-shipping-estimates')): ?>
    <small>Estimate shipping &amp; taxes for:</small>
    <?php shopp('cart','shipping-estimates'); ?>
<?php endif; ?>

See Also

You must be logged in to post a comment.

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

Skip to toolbar