Prints filtering tools of the search engine included in paid MyCashflow plans, thanks to which the visitor can limit search results.

Description

This tag is available only in paid MyCashflow plans.

By default, filters are printed as <ul> lists that contain the following:

The {SearchFilters} tag's default output is often used to implement search tools in a theme. However, you can edit the markup and content of the search filter list by using filters' own tags in the tag's helper attribute.

The search engine included in paid MyCashflow plans contains the following search-filters:

  • Price category
  • Product category
  • Brand

See also detailed instructions on how to implement search tools in an online store theme.

Syntax

{SearchFilters(
    limit: int,
    name: string,
    helper: string
)}

Scope

Required scope: globaali

Scope in helper attribute: search-filter

The tag is used to limit the products returned by a search on the search engine result page.

Attribuutit

limit:

Defines the maximum number of search filters to be printed.

Allowed values:integers

name:

To print only the desired search filters, use attributes.

Allowed values:

  • 'brand': the brand filter
  • 'category': the product category filter
  • 'price_range': the price filter
  • 'all': prints all filters (default value)

To separate multiple values, use pipes. E.g. name: 'brand|category'

helper:

Defines the content and output format of a single list element.

Allowed values: the Interface and HTML markup that define the output's markup and content.

The helper attribute can be used in two ways:

  1. you can indicate the desired markup directly as the attribute's value, or
  2. you can indicate a reference to a file with the desired markup as the attribute's value.

    The reference should be indicated in relation to the theme's root directory.

See also detailed instructions on using the helper attribute.

after/before:

By using the after and before attributes you can define content that is output either after or before the tag's output.

Allowed values:The HTML and Interface markup

E.g.

  • before: '<p>Tämä merkkaus näkyy ennen tagin omaa sisältöä.</p>'
  • after: '<p>Tämä taas näkyy tagin oman sisällön jälkeen.</p>'

If the tag does not produce any content, neither the content of the after and before attributes will be output.

or:

Defines alternative content that is displayed if the tag itself does not produce any content.

Allowed values:The HTML and Interface markup

E.g. or:'Sisältöä ei löytynyt.'

escape:

Adds an escape character before quotation marks in the output.

The attribute makes it easier to process the tag-produced content when using JavaScript.

Allowed values:true/false. The default value is false.