shopp('storefront.orderby-list')

Displays a list of product listing sort order options for the products displayed in a category.

shopp('storefront', 'orderby-list', '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 string Markup for a product sort order control menu

Displays a list of product listing sort order options for the products displayed in a category. This tag does not display sort order options for smart collections.

It has been noted that this control element will not work properly when used in a category or collection shown on the front page of WordPress due to a known and reported bug in WordPress core. See the bug report Wrong page loaded requesting custom registered query_vars when correcting is_* for page_on_front requests

Options

  • default: Allows custom override of the global default set by the Product Order setting available under ShoppSettingsPresentation. Accepts values of: bestselling, highprice, lowprice, newest, oldest, random, title. If an invalid option is specified, the title option is used.
  • dropdown: Default is on. Specifies whether to display the list as a set of unordered list items <li> (the default) or as a set of drop-down menu options <select><option></select> Example:
  • title: Default is (empty). Allows you to specify a title that is displayed before the menu of 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.

See Also

You must be logged in to post a comment.

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

Skip to toolbar