shopp('storefront.catalog-products')

Displays the Catalog Products smart collection which displays all of the published products in the catalog.

shopp('storefront', 'catalog-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 string Markup for the Catalog Products smart collection

Displays the Catalog Products smart collection.

The Catalog Products smart collection displays all of the published products in Shopp’s catalog.

Options

  • title: Specifies the title to be shown for the category layout overriding the default category title.
  • controls: Default is off. Overrides the display of “control” elements in the category.php template that would otherwise be shown. Used to highlight a selection of products in a category without all of the extra category controls.
  • show: No default value. Limits the number of products to show in the category display. Without a specified limit, a built-in hard limit of 1000 products is used to keep the server’s resources from being totally consumed.
  • load: Default is false. When false, it will display the catalog-products category. When true it will load the catalog-products category into memory, making it available for using Category Tags rather than displaying the catalog-products category using the category template file Category Tags.
  • pagination: Default is numeric. Set to alpha this option will use alphabetic pagination, otherwise it will default to numeric.
  • order: Default is title. Possible settings include: bestselling, highprice, lowprice, newest, oldest, random, and title
  • exclude: No default value. Exclude products in a given category ID.

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.

Examples

Exclude products assigned to categories 1, 3 & 7

<?php shopp('storefront.catalog-products','exclude=1,3,7'); ?>

See Also

You must be logged in to post a comment.

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

Skip to toolbar