Prints a list of the product category's featured products.

Kuvaus

Products are marked for advertising in the product form field Visibility settings > Featured product.

By default, the tag prints the following information for each product:

This tag is an alias for the {Products} tag. You can print the same content with the correct attributes of the {Products} tag.

Syntaksi

{CategoryHotPicks( subcategories: boolean, brand: int, campaign: int, id: int, keyword: string, timelimit: string, similar_to: int / string, compatible_to: int / string, crosssales_for: int / string, fallback: boolean, limit: int, prelimit: int, sort: string, pagination: boolean, type: string, list_type: string, list_classes: string, classes: string, helper: string )}

Näkyvyys

Toimii näkyvyydessä: tuoteryhmä

Näkyvyyshelper-attribuutissa: tuote

The required scope is always set in the following templates:

Templates
Product list
Display window
Front page

Attribuutit

subcategories:

Determines whether the product search also targets the subcategories of the product category in question.

Allowed values: true/false. Default value: true.

brand:

Selects products by brand.

Allowed values: brand ID numbers.

To specify multiple brands, separate their ID numbers with vertical bars (e.g. brand:'2|34|5'). With the value 'ALL', the product search applies to all brands.

campaign:

Selects products according to a campaign.

Allowed values: campaign ID numbers.

To define multiple campaigns, separate their ID numbers with vertical bars (e.g., campaign:'2|34|5'). With the value 'ALL', the product search applies to all campaigns.

id:

Selects products based on their ID numbers.

Allowed values: pipe-separated product ID numbers

keyword:

Search terms that define which products should be displayed on the list.

To learn more about how the search works, see our user guide.

Allowed values: space-separated search terms.

E.g. keyword:'shirts pants Jamppa'

timelimit:

Sets the time interval for the product search in the list.

Allowed values:

  • Days: '-n days'
  • Weeks: '-n weeks'
  • Months: '-n months'

E.g. timelimit:'-3 months'

With the value 0, you can completely disable the time limit.

similar_to:

Defines the products for which products marked as similar should be printed on a list.

Sallitut arvot: pipe-separated product ID numbers or one of the preset filters:
  • 'cart': selects cross-sell products based on the products in the shopping cart
  • 'last_viewed': selects cross-sell products based on the products recently viewed by the customer
  • 'last_bought': selects cross-sell products based on the products recently purchased by the customer (the customer must be logged in)

If ready filters do not produce any results, the attribute will try to retrieve cross-sell products based on the products belonging to the scope. You can prevent this with the attribute definition fallback:false.

Esim.: similar_to:'1|14|24' or similar_to:'cart'

compatible_to:

Defines the products for which compatible products should be retrieved and displayed on a list.

Sallitut arvot: pipe-separated product ID numbers or one of the preset filters:
  • 'cart': selects cross-sell products based on the products in the shopping cart
  • 'last_viewed': selects cross-sell products based on the products recently viewed by the customer
  • 'last_bought': selects cross-sell products based on the products recently purchased by the customer (the customer must be logged in)

If ready filters do not produce any results, the attribute will try to retrieve cross-sell products based on the products belonging to the scope. You can prevent this with the attribute definition fallback:false.

E.g. compatible_to:'1|34|2' or compatible_to:'cart'

crosssales_for:

Defines the products for which products that were sold together should be retrieved and displayed on the list.

Sallitut arvot: pipe-separated product ID numbers or one of the preset filters:
  • 'cart': selects cross-sell products based on the products in the shopping cart
  • 'last_viewed': selects cross-sell products based on the products recently viewed by the customer
  • 'last_bought': selects cross-sell products based on the products recently purchased by the customer (the customer must be logged in)

If ready filters do not produce any results, the attribute will try to retrieve cross-sell products based on the products belonging to the scope. You can prevent this with the attribute definition fallback:false.

E.g. crosssales_for:'1|2|3' or crosssales_for:'last_viewed'

fallback:

Prevents the cross-sell attributes' default values from being used.

See also detailed instructions on using cross-sell attributes.

This attribute is used only if any of the following attributes has a value assigned: similar_to, compatible_to or crosssales_for.

Allowed values: true/false. Default value: true.

limit:

Sets the maximum length of the output list.

The limiting settings of the pagination tools are determined based on the values of the limit attribute as well.

Allowed values: a list of integers separated by pipes.

The first integer in the list serves as the default in the limit selection menu produced by the {PaginationLimit} tag.

E.g. limit:'1|5|10'

prelimit:

Limits the length of the output list before pagination and sorting according to the sort attribute.

This attribute is mainly used to pick, for example, 10 most relevant products from cross-sell and search result lists, and randomly display a limited number of them.

Allowed values: integers.

sort:

Defines the sorting criteria for the list. The attribute values also determine the available values in the pagination arrangement menu.

Allowed values:

  • 'search': the order manually defined in the admin panel
  • 'last_sold': recently sold products first
  • 'name_asc': in alphabetical order based on names (A-Z)
  • 'name_desc': in reverse alphabetical order based on names (Z-A)
  • 'price_asc': lowest price first
  • 'price_desc': highest price first
  • 'released_asc': date added (oldest first)
  • 'released_desc': date added (newest first)
  • 'random': random order
  • 'sales_asc': least sold first
  • 'sales_desc': bestsellers first

If you'd like to use multiple sorting criteria, separate the values with pipes.

E.g. sort:'name_asc|name_desc|released_asc'

pagination:

Defines whether pagination tools should be displayed.

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

type:

Determines the markup type of the output list.

Sallitut arvot:
  • 'normal': Each item in the list is its own div element. The list does not have a surrounding element.
  • 'list': The list is printed as an HTML list. By using the list_type attribute, you can define the type of list.
  • 'ids': The tag prints only the product ID numbers as a string separated by vertical bars without HTML markup.
list_type:

Determines whether the product list is printed as an unordered or ordered (numbered) list.

The attribute is enabled only if the type attribute's value is 'list'.

Sallitut arvot:
  • 'ul': the product list is printed as an unordered list
  • 'ol': the product list is printed as an ordered list
list_classes:

Class names given to any list element that contains a list (<ul> or <ol>, depending on the value of the list_type attribute).

The attribute is enabled only if the type attribute's value is 'list'.

Allowed values: space-separated class names as strings.

E.g. list_classes:'firstClass secondClass'

classes:

Class names that are given to every list element.

Allowed values: class names as strings.

Use space characters to separate the classes that are to be given to the same element. Use pipes to separate the classes that are to be given to different list elements.

E.g. classes:'firstClass secondClass | everyOthersClass everyOthersSecondClass'

See also detailed instructions on how to define list class names.

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:

  • you can indicate the desired markup directly as the attribute's value, or
  • 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.

before/after:

With the before and after attributes, you can define content that is output before or after the content produced by the tag.

Allowed values: text that may contain HTML and Interface markup.

E.g.

  • before: '<p>This markup appears before the tag's own content.</p>'.
  • after: '<p>This appears after the tag's own content.</p>'

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

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.

or:

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

Allowed values: text that may contain HTML and Interface markup.

E.g. or:'Content not found.'