shopp('storefront.is-frontpage')

Alias for the is_catalog_frontpage() core api function.

shopp('storefront', 'is-frontpage', '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 bool true if the current page request is for the Shopp catalog frontpage, false if not.

Alias for the is_catalog_frontpage() 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

Preferred Form

is_catalog_frontpage();

Deprecated Forms

shopp('storefront.is-frontpage');
shopp('storefront.is-landing');
shopp('catalog.is-frontpage');
shopp('catalog.is-landing');

Examples

if ( shopp('storefront', 'is-frontpage' ) ) {
    // do stuff here if on the storefront frontpage
}
if ( shopp('catalog.is-landing') ) {
    // do stuff here if on the storefront frontpage
}
if ( is_catalog_frontpage() ) {
    // do stuff here if on the storefront frontpage
}

See Also

You must be logged in to post a comment.

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

Skip to toolbar