Display an unordered list of promotions associated with the current order.

shopp('purchase', 'promo-list', '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, string unordered list of promotions when return option is used.

Alternative Forms

shopp('', 'options');


Display an unordered list of promotions associated with the current 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.




shopp('purchase', 'promo-list');

See Also

  1. shopp('purchase','promolist');
    this works

    March 12th   #

  2. All theme api calls can take any combination of hyphenation (dashes) for the second argument. shopp('purchase','promolist') and shopp('purchase','promo-list') are handled identically, as are shopp('purchase.promolist') and shopp('').

    This was not true prior to Shopp 1.2.

    May 30th   #

  3. The example is confusing:

    if ( shopp(‘purchase’,’has-promos’) ) {
    shopp(‘purchase’, ‘promo-list’);

    shopp(‘purchase’,’has-promos’) doesn’t exist in the API docs and doesn’t seem to work either.
    shopp(‘purchase’,’has-promo’) can only be used for a specific name.

    shopp(‘cart’,’has-promos’) does exist but isn’t useful. I need to test if the purchase has any promos applied so I can display them on the merchant order email.

    May 15th   #

You must be logged in to post a comment.

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