Displays the name of the discount currently applied. Used within a shopp('cart'.discounts') loop.

shopp('cart', 'discount-name', '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 string The name of the discount that that applies to the shopping cart

This tag displays the name of a discount that applies to the shopping cart as entered into the Discount manager in the WordPress Admin. Used by itself, this tag will show the name of the first discount that applies to the order. Typically this tag is used with the shopp('cart.discounts') tag in a PHP while () loop to show all of the discounts that currently apply to the order.


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.


<?php shopp(''); ?>

As used in the default cart.php content template

<?php while( shopp('cart.discounts') ): ?>
        <td colspan="4" class="money">
        <?php shopp(''); ?>
        <strong><?php shopp('', array('before' => '&nbsp;&mdash;&nbsp;')); ?></strong>
<?php endwhile; ?>

See Also

You must be logged in to post a comment.

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