shopp('collection.faceted-menu')

Shows a faceted menu of filter options to find products in the current category.

shopp('collection', 'faceted-menu', '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 faceted menu if the return option is used.

Alternative Forms

shopp('collection.faceted-menu', 'options');

Description

Displays the pre-programmed faceted menu for a product category.

When a facetedmenu.php or facetedmenu-{slug}.php content template (for a specific category slug) is found in your theme’s shopp/ subdirectory, it will be used for the output of this function.

It is good practice to test for the presence of a faceted menu setting in the product category before calling this Theme API function.

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

None

Examples

shopp('collection', 'faceted-menu');

Check to see if the current category has a faceted menu

<?php
if ( is_a(ShoppCollection(),'ProductCategory') && shopp('collection.has-faceted-menu') ) :
    shopp('collection.faceted-menu');
endif;
?>

See Also

You must be logged in to post a comment.

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

Skip to toolbar