Template variables

This page contains list of variables that can be used in SEO templates, SEO rewrites, and Rich snippet extenders.

note

The extension will hide any variable in the rule if it is not set for the proper template. To hide some particular text around the variable, use [some text {variable} other text].

Category page variables

Option	Description
[category_name]	name of the category.
[category_description]	category description.
[category_url]	category URL.
[category_title_h1]	H1 title of the category. Falls back to category name if not set.
[category_page_title]	meta title of the category.
[category_parent_name]	name of the parent category.
[category_parent_name_{level}]	name of the parent category at a specific level. For example, [category_parent_name_2] returns the grandparent category name. Levels 1-3 are supported.
[category_parent_url]	URL of the parent category.
[category_meta_title]	meta title of the category.
[store_name]	name of the current store.
[store_url]	URL of the current store.
[store_address]	address of the current store.
[store_phone]	phone number of the current store.

Product page variables

Option	Description
[product_{attribute_code}]	{attribute_code} is any attribute which can be found in Catalog -> Attributes -> Manage attributes. For example, an attribute with the attribute label Decor type and attribute code decor_type a corresponding template variable will be [product_decor_type]. The same goes for [product_brand], [product_size], etc.
[product_name]	product's name.
[product_sku]	product's SKU.
[product_url]	product's full URL, including the domain. Not suitable for the URL key template.
[product_page_title]	product's meta title.
[product_price]	product's regular price.
[product_special_price]	product's special price.
[product_final_price]	product's final price.
[product_final_price_minimal]	product's final price (for bundle, configurable and grouped products returns minimal price).
[product_final_price_range]	product's final price (for bundle, configurable and grouped products returns price range).
[product_brand]	product's brand.
[product_entity_id]	product's ID.
[product_parent_name]	parent configurable product's name. Falls back to the current product if no parent exists.
[product_parent_url]	parent configurable product's URL. Falls back to the current product if no parent exists.
[product_category_name]	name of the product's category: the current category, or the category page the visitor came from; otherwise, the active category the product was assigned to last.
[category_name]	name of the category.
[category_description]	category description.
[category_url]	category URL.
[category_parent_name]	name of the parent category.
[category_parent_url]	URL of the parent category.
[store_name]	name of the current store.
[store_url]	URL of the current store.
[store_address]	address of the current store.
[store_phone]	phone number of the current store.

URL key template variables

The URL key template and the bin/magento mirasvit:seo:product-url-template command build URL keys outside any storefront page, so only variables that read the product itself return a value. Choose them from this list:

Option	Result in the URL key
[product_name]	product's name, for example strive-shoulder-pack.
[product_url_key]	product's current URL key.
[product_sku]	product's SKU.
[product_{attribute_code}]	value of any product attribute, for example [product_color].
[product_category_name]	name of a category the product is assigned to. See the note below.

Avoid these variables in the URL key template:

• [product_url] returns the full product URL with the domain, not a URL key. The URL key turns into something like http-www-example-com-strive-shoulder-pack-html. For the product part of the URL key, use [product_name] or [product_url_key].
• [category_name], [category_url] and the other category page variables return a value only on a category page, so in the URL key template they are empty. For a category part of the URL key, use [product_category_name].

note

[product_category_name] takes the category the product was assigned to last, among its active categories. A category hidden from the menu (Include in Menu set to No) counts as well. If a product's last-assigned category is a hidden or promotional one, such as "Featured", that category becomes part of the URL key. Two products with the same name in that category get the same URL key, and the command skips the second one with Duplicate used url key. Assign such products to a visible category, or make their names unique, and run the command with --apply again.

CMS page variables

Option	Description
[cmsPage_title]	title of the CMS page.
[cmsPage_meta_keywords]	keywords of the CMS page.
[cmsPage_meta_description]	meta description of the CMS page.
[cmsPage_content_heading]	content heading of the CMS page.
[cmsPage_content]	content of the CMS page.
[cmsPage_meta_title]	meta title of the CMS page.

Layered navigation variables

Option	Description
[filter_selected_options]	returns the values of the chosen attributes in the layered navigation. Format: <selected options of attribute1>, <selected options of attribute2>. For example, Asus, Red, Black Intel Core I5.
[filter_named_selected_options]	returns names with values of the chosen attributes in the layered navigation. Format: <name of attribute1>: <selected options of attribute1>, <name of attribute2>: <selected options of attribute2>. For example, Brand: Asus, Color: Red, Black CPU: Intel Core I5.
[category_name]	name of the category.
[category_description]	category description.
[category_url]	category URL.
[category_parent_name]	name of the parent category.
[category_parent_url]	URL of the parent category.
[store_name]	name of the current store.
[store_url]	URL of the current store.
[store_address]	address of the current store.
[store_phone]	phone number of the current store.

Blog variables

note

Available only if Mirasvit Blog is installed.

Option	Description
[blog_name]	name of the blog entity (post, category, or author).
[blog_meta_title]	meta title of the blog entity.
[blog_meta_keywords]	meta keywords of the blog entity.
[blog_meta_description]	meta description of the blog entity.
[blog_post_author]	name of the post author.
[blog_post_categories]	comma-separated list of post category names.
[blog_post_tags]	comma-separated list of post tag names.
[blog_post_content]	content of the blog post.
[blog_author_job_title]	job title of the blog author.
[blog_author_short_bio]	short bio of the blog author.
[blog_author_full_bio]	full bio of the blog author.
[blog_category_url]	URL of the blog category.
[blog_category_parent_name]	name of the parent blog category.
[blog_category_parent_url]	URL of the parent blog category.

Brand variables

note

Available only if Mirasvit Brand is installed.

Option	Description
[brand_name]	name of the brand.
[brand_meta_title]	meta title of the brand page.
[brand_meta_keywords]	meta keywords of the brand page.
[brand_meta_description]	meta description of the brand page.

Landing page variables

note

Available only if Mirasvit Landing Page is installed.

Option	Description
[landing_name]	name of the landing page.
[landing_page_title]	page title of the landing page.
[landing_meta_title]	meta title of the landing page.
[landing_meta_description]	meta description of the landing page.
[landing_url_key]	URL key of the landing page.

tip

On landing pages, the category variables [category_name], [category_title_h1], and [category_page_title] automatically resolve from landing page data instead of category data.

Store variables

These variables are available across all template types.

Option	Description
[store_name]	name of the current store.
[store_url]	URL of the current store.
[store_phone]	phone number of the current store.
[store_email]	email address of the current store.
[store_street_line_1]	first line of the store street address.
[store_street_line_2]	second line of the store street address.
[store_city]	city of the current store.
[store_postcode]	postal code of the current store.
[store_address]	full formatted address of the current store.

Current page variables

These variables return values from the currently rendered page, regardless of page type. They are useful as fallback values.

Option	Description
[page_title]	title of the current page.
[page_meta_description]	meta description of the current page.
[page_meta_keywords]	meta keywords of the current page.

Pagination variable

Option	Description
[pager_page]	current page number (e.g., "Page 2"). Returns empty on the first page.