shopp('cartitem.addons-list')

Displays all of the product addons for the cart item in an unordered list (<ul>).

shopp('cartitem', 'addons-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, list markup of addons if return option is used.

Alternative Forms

shopp('cartitem.addons-list', 'options');

Description

Displays all of the product addons for the cart item in an unordered list (<ul>).

This tag is typically used when looping through cart items.

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.

  • before: Text or markup to be displayed before add-ons list.
  • after: Text or markup to be displayed after the add-ons list.
  • class: Default is (empty). Allows you to specify a custom class for the <ul> element.
  • exclude: Used to specify addon labels to exclude from displaying in the list. Multiple add-ons can be excluded by separating them with a comma: Addon Label 1,Addon Label 2….
  • prices: Default is on. A boolean option (on or off) to show the price for the add-on in addition to the label.

Examples

<?php shopp('cartitem','addons-list'); ?>
<?php shopp('cartitem','addons-list','prices=off'); ?>
if ( shopp('cart','has-items') ) {
    while ( shopp('cart','items') ) {
        shopp('cartitem','addons-list');
    }
}

See Also

You must be logged in to post a comment.

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

Skip to toolbar