shopp('purchase.item-download')

Displays the download link for the current item.

shopp('purchase', 'item-download', '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 download link when return option is used

Alternative Forms

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

Description

Displays the download link for the current item.

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.

  • label: Default is Download. The text to be used to for the download link.
  • class: css classes to add to the anchor tag.

Examples

<?php shopp('purchase','item-download'); ?>
if ( shopp('purchase', 'has-downloads') ) {
    while ( shopp('purchase', 'items') ) {
        if ( 'Download' == shopp('purchase', 'get-item-type') ) {
            // Display the Download Link
            shopp('purchase', 'item-download');
        }
    }
}
if ( shopp('purchase', 'has-downloads') ) {
    while ( shopp('purchase', 'items') ) {
        if ( 'Download' == shopp('purchase', 'get-item-type') ) {
            // Display the Download Link
            shopp('purchase', 'item-download', 'label=Download Now&class=download');
        }
    }
}

See Also

You must be logged in to post a comment.

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

Skip to toolbar