Prints the comparison price of a campaign product, which can be the list price or the lowest campaign price from the previous 30 days.

Kuvaus

The tag only prints the comparison price if it is different from the sales price.

You can print the up-to-date discounted sales price by using the {ProductPrice} tag.

If you want to print the product's list price regardless of whether it is the same as the sale price, use the {ProductListPrice} tag.

Syntaksi

{ProductComparePrice( mode: string, includetax: boolean, price_format: string, currencysymbol: string, decimals: int, decimalsep: string, thousandssep: string, html: string )}

Näkyvyys

Toimii näkyvyydessä: tuote

The required scope is always set in the following templates:

Templates
Single product template
Product images

Displaying prices on product pages

This example shows the product's sale and list price on the product page.

... <p> {ProductComparePrice( currencysymbol: 'true', <!-- If there is a discount on the price, the sale price is shown before the list price with the {ProductPrice} tag. --> before: ' {ProductPrice( currencysymbol: 'true', before: '<span>{%Price}&nbsp;', after: '</span>' )} <span class="ProductComparePrice">', after: '</span>', <!-- If there are no discounts, the list price is displayed with the {ProductPrice} tag. --> or: ' {ProductPrice( currencysymbol: 'true', before: '<span>{%Price}&nbsp;', after: '</span>' )}' )} </p> ...

The example below shows how prices can be displayed in a theme.

Attribuutit

mode:

Determines whether the tag displays the campaign product's list price or the Omnibus comparison price, which is the lowest selling price from the previous 30 days.

Sallitut arvot:
  • auto (default): The tag prints either the Omnibus comparison price or the list price.
  • list: The tag prints the list price only if it differs from the sale price (otherwise, the tag does not print anything).
  • comparison: The tag prints the Omnibus comparison price if it differs from the list price. If the Omnibus comparison price is the same as the list price, the tag does not print anything.
includetax:

Determines whether the tag prints the price including VAT.

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

price_format:

Determines the price information display format.

Sallitut arvot:
  • string (default): The price information is printed as a string, which may also include formatting and additions dependent on other attributes of the tag (e.g., currency symbol).
  • decimal: The price information is printed as a decimal number using a decimal point (e.g., 9.90), which works in, among other things, JavaScript code.

    If price_format: 'decimal' is in use, other price information formatting attributes do not affect the tag's output.

currencysymbol:

Determines whether the tag also prints the currency symbol. The symbol is automatically determined based on the currency in use.

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

The currency symbol can also be printed using the {CurrencySymbol} tag.

decimals:

Sets the precision for printing decimals.

Allowed values: integers. Default value 2 decimal places.

decimalsep:

Defines the decimal separator character. The most popular decimal separators are comma and dot, the use of which depends on the store's locale.

Sallitut arvot: merkki, joka toimii desimaalierottimena (esim. desimaalipiste = decimalsep: '.'). Oletusarvo pilkku.
thousandssep:

Specifies the character used as the thousands separator.

According to the International System of Units, the thousand separator is a space, but in different countries, a period, comma, or apostrophe may traditionally be used. You may want to define thousands separators according to the locale.

Allowed values: a symbol that functions as a thousands separator. The default is a non-breaking space &nbsp;

If you want to use an apostrophe as the thousands separator, write it between double quotes: thousandssep: "'"

If you do not want to use any thousands separator, just write two quotation marks or two apostrophes in a row in the attribute: thousandssep: "" or thousandssep: ''

html:

Determines whether the tag outputs the default HTML markup around the content.

Allowed values: true / false

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.'