shopp('collection.facet-filter')

Displays the current faceted menu filter value.

shopp('collection', 'facet-filter', '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 filter value if return option is used.

Alternative Forms

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

Description

Displays the current faceted menu filter value.

This Theme API call can be used within the shopp('collection','facet-filters) loop (of currently applied faceted filter options) to display the query value used to limit the list of products in the collection.

This value will match the input option value used in the faceted menu; The value of the filter option shopp('collection','facet-option-value') when used in the shopp('collection','facet-options') loop.

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

Display links to cancel current category filters

<?php
if (shopp('collection.is-facet-filtered')) : ?>


<ul>
    <?php // Loop through toggled filters for this category
    while(shopp('collection.facet-filters')) : ?>
    <li>
        <strong><?php
        // facet menu name of toggled filter
        shopp('collection.facet-name'); ?>:</strong>&nbsp;<?php
        // current toggled facet filtered value
        shopp('collection.facet-filter'); ?>
        <a href="<?php
        // current toggled facet toggle link url
        esc_url(shopp('collection.facet-link')); ?>" class="cancel">X</a>
    </li>
    <?php endwhile; ?>
</ul>

<br />
<?php 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