shopp('purchase.item-addons')

shopp('purchase', 'item-addons', '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 bool true while looping through purchased item's addons, false when finished looping.

Alternative Forms

shopp('purchase.item-addons', 'options');

Description

Used to loop through a purchased item’s addons.

This theme api call is used inside the purchased items loop. You should test to see if there are purchased item addons before looping through them.

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

None

Examples

shopp('purchase', 'item-addons', 'options...');

// test for purchased items
if ( shopp('purchase','has-items') ) {

    // loop through purchased items
    while ( shopp('purchase', 'items') ) {

        // test for purchased item addons
        if ( shopp('purchase', 'item-has-addons') ) {

            //loop through purchased item addons
            while ( shopp('purchase', 'items-addons') ) {
                // do stuff here
            }
        }
    } 
}

See Also