Prints details of a single campaign. The tag works globally, which means that you can use it on any page of your online store.

Description

By default, the tag does not output anything; the entire content must be defined using the helper attribute.

Syntax

{Campaign(
    id: int,
    helper: string
)}

Scope

Required scope: global

Scope in helper attribute: campaign

It is possible to use global visibility tags in any page template and within any tag.

Printing campaign details with the {Campaign} tag

The {Campaign} tag enables you to effortlessly print any campaign detail outside the campaign page. The tag itself doesn't print anything, but you can use any of the campaign tags in its helper attribute.

The example illustrates how to print basic campaign details by using the {Campaign} tag.

The relevant campaign is indicated by using the id attribute. After this, the content to be printed is defined in the helper attribute.

{Campaign(
    id: 6,
    helper: {{
        <h2>{CampaignName}</h2>
        {CampaignDescription}
        {CampaignProducts(
          helper: {{
            <div><h3>{ProductName}</h3>
              {ProductListImage}
              {ProductCampaignPrice}
              {ProductAddToCart}
            </div>
          }}
        )}
    }}
)}

First, the campaign name and description are printed. The campaign products are then printed with the {CampaignProducts} tag. Note that product tags can be used within this product list because its scope has been set to product.

Attribuutit

id:

Sets the ID number of the relevant campaign.

Allowed values:An integer.

helper:

Defines the content and markup format of a printout.

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 these two 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 escape characters to the content printed by the tag, making it easier to use the content in JavaScript code or JSON objects.

Allowed values:
  • true: the attribute adds escape characters before quotation marks
  • false: the attribute does nothing
  • json: the attribute adds escape characters to the output, allowing the content to be used in JSON markup.
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.'