shopp('storefront.is-catalog')

Alias for is_catalog_page() core api function.

shopp('storefront', 'is-catalog', '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 boolean true if is a storefront product catalog page, false if not a storefront product catalog page.

Alias for is_catalog_page() Developer API function.

Options

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.

Alternative Forms

shopp('storefront.is-catalog', 'options');
shopp('catalog', 'is-catalog', 'options');

Preferred Form

is_catalog_page();

Examples

if ( shopp('storefront.is-catalog') ) {
    // do catalog page code
}
if ( is_catalog_page() ) {
    // do catalog page code
}

See Also

  1. Avatar of James

    Despite the name, this function returns true on the catalog, category, and product templates. Use is_catalog_frontpage() to check if you’re viewing the catalog.php template.

    May 14th   #

  2. Avatar of Jonathan Davis

    To clarify the Shopp catalog consists of categories, smart collections and products, so it is proper to for this function to return true in all of those cases.

    May 14th   #

You must be logged in to post a comment.

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

Skip to toolbar