shopp('collection.products')

Loops through the products in a given product collection to display information specific to a single product in the collection.

shopp('collection', 'products', '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 true while looping through products, false when finished looping

Alternative Forms

shopp('collection.products', 'options...');

deprecated form

shopp('category','products','options...');

Description

This is a construct similar to “The Loop” in WordPress and operates in much the same manner. It is the main product loop where you typically use Product Tags to layout how an individual product looks in your collection view.

Important, use shopp(‘collection’,’has-products’) to determine if the collection has products, and to load the products into the collection data set.

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.

None

Examples

Basic content template example

<?php if ( shopp('collection','has-products') ): ?>
<?php while(shopp('collection','products')) { … } ?>
<?php endif; ?>

Basic code example

if ( shopp('collection','has-products') ) {
    while ( shopp('collection','products') ) {
        // do shopp('product','tagname') calls here
        shopp('product','name'); // displays product name
    }
}

See Also

You must be logged in to post a comment.

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

Skip to toolbar