shopp('collection.facet-name')

Displays the current faceted menu name.

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

Alternative Forms

shopp('collection.facet-name', 'options');

Description

Displays the current faceted menu name.

This Theme API call can be used within the shopp('collection.facet-filters) loop (of currently applied faceted filter options) or within the shopp('collection.facet-options') loop (of selectable faceted filter 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.

Options

None

Examples

shopp('collection.facet-name');

Used in current filters loop

<?php 
if (shopp('collection.is-facet-filtered')) :    
    // Loop through toggled filters for this category
    while(shopp('collection.facet-filters')) :
        // name of current active faceted menu filter option
        shopp('collection.facet-name');
    endwhile;
endif; 
?>

Used in faceted filter options loop

<?php 
if ( is_a(ShoppCollection(),'ProductCategory') && shopp('collection.has-faceted-menu') ) : 
    // Outside faceted menu loop
    while ( shopp('collection.facet-menus') )
        if ( shopp('collection.facet-menu-has-options') ) :
            // Inside faceted menu filter options
            while(shopp('collection.facet-options')) :
                // name of current faceted menu filter option
                shopp('collection.facet-name');
            endwhile; // end facet-options loop
        endif;
    endwhile; // end facet-menus loop
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