shopp('collection.facet-option-link')

Display the toggle link url of the current faceted menu filter option.

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

Alternative Forms

shopp('collection.facet-option-link', 'options');

Description

Display the toggle link url of the current faceted menu filter option.

This function is 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-option-link');

Used in facet options loop

while ( shopp('collection.facet-options') ) {
    shopp('collection.facet-option-link');
}

All links for all facet menus

<?php while(shopp('collection.facet-menus')) : ?>
    <h2><?php shopp('collection.facet-name'); ?></h2>
    <?php while ( shopp('collection.facet-options') ) : ?>
        <a href="<?php shopp('collection.facet-option-link'); ?>">
            <?php shopp('collection.facet-option-label'); ?>
        </a>
    <?php endwhile; ?>
<?php endwhile; ?>

See Also

You must be logged in to post a comment.

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

Skip to toolbar