shopp('purchase.item-description')

Displays a purchased item’s description.

shopp('purchase', 'item-description', '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, the purchased item description if return value is used.

Alternative Forms

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

Description

Displays a purchased item’s description.

This function is used inside a purchased item loop, and only when the global purchase content exists. If not already loaded, purchased items are loaded when the shopp(‘purchase’,’has-items’) theme api call is made to check for purchased 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

None

Examples

shopp('purchase', 'item-description', 'options...');
<?php if ( shopp('purchase','has-items') ): ?>
<ul>
<?php while( shopp('purchase','items') ): ?>
    <li><?php shopp('purchase','item-description'); ?></li>
<?php endwhile; ?>
</ul>
<?php endif; ?>
$items = array();

if ( shopp('purchase','has-items') ) {
    while ( shopp('purchase','items') ) {
        // capture the purchased item descriptions
        $items[] = shopp('purchase','get-item-description');
    }
}

See Also

You must be logged in to post a comment.

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

Skip to toolbar