Skip to main content

metafield_tag

metafield | metafield_tag
returns string

Generates an HTML element to host the data from a metafield object. The type of element that's generated differs depending on the type of metafield.

Note

The metafield_tag filter doesn't currently support list metafields other than list.single_line_text_field and list.metaobject_reference.

Anchor to Basic types

Basic types

Most metafield types return a simple HTML element:

TypeElementAttributes
boolean<span>class="metafield-boolean"
collection_reference<a>class="metafield-collection_reference"
color<span>class="metafield-color"
date<time>datetime="<the metafield value>"

class="metafield-date"

Value is localized to the customer
date_time<time>datetime="<the metafield value>"

class="metafield-date"

Value is localized to the customer
json<script>type="application/json"

class="metafield-json"
money<span>class="metafield-money"

Value is formatted using the store's HTML with currency setting
multi_line_text_field<span>class="metafield-multi_line_text_field"
number_decimal<span>class="metafield-number_decimal"
number_integer<span>class="metafield-number_integer"
page_reference<a>class="metafield-page_reference"
product_reference<a>class="metafield-page_reference"
rating<span>class="metafield-rating"
single_line_text_field<span>class="metafield-single_line_text_field"
url<a>class="metafield-url"
variant_reference<a>class="metafield-variant_reference"
rich_text_field<div>class="metafield-rich_text_field"
<!-- boolean -->
{{ product.metafields.information.seasonal | metafield_tag }}

<!-- collection_reference -->
{{ product.metafields.information.related_collection | metafield_tag }}

<!-- color -->
{{ product.metafields.details.potion_color | metafield_tag }}

<!-- date -->
{{ product.metafields.information.expiry | metafield_tag }}

<!-- date_time -->
{{ product.metafields.information.brew_date | metafield_tag }}

<!-- json -->
{{ product.metafields.information.burn_temperature | metafield_tag }}

<!-- money -->
{{ product.metafields.details.price_per_ml | metafield_tag }}

<!-- multi_line_text_field -->
{{ product.metafields.information.shipping | metafield_tag }}

<!-- number_decimal -->
{{ product.metafields.information.salinity | metafield_tag }}

<!-- number_integer -->
{{ product.metafields.information.doses_per_day | metafield_tag }}

<!-- page_reference -->
{{ product.metafields.information.dosage | metafield_tag }}

<!-- product_reference -->
{{ product.metafields.information.related_product | metafield_tag }}

<!-- rating -->
{{ product.metafields.details.rating | metafield_tag }}

<!-- single_line_text_field -->
{{ product.metafields.information.directions | metafield_tag }}

<!-- url -->
{{ product.metafields.information.health | metafield_tag }}

<!-- variant_reference -->
{{ product.metafields.information.best_seller | metafield_tag }}

<!-- rich_text_field -->
{{ product.metafields.information.rich_description | metafield_tag }}

Output

<!-- boolean -->
<span class="metafield-boolean">false</span>

<!-- collection_reference -->
<a href="/collections/sale-potions" class="metafield-collection_reference">Sale potions</a>

<!-- color -->
<span class="metafield-color">#ff0000</span>

<!-- date -->
<time datetime="2040-01-01" class="metafield-date">January 1, 2040</time>

<!-- date_time -->
<time datetime="2022-06-22T13:00:00Z" class="metafield-date_time">Jun 22, 2022, 1:00 pm</time>

<!-- json -->
<script type="application/json" class="metafield-json">{"temperature":"700","unit":"degrees","scale":"Fahrenheit"}</script>

<!-- money -->
<span class="metafield-money">$0.10 CAD</span>

<!-- multi_line_text_field -->
<span class="metafield-multi_line_text_field">All health potions are made to order, so it might take up to 2 weeks before your order can be shipped.<br />
<br />
Thanks for your patience!</span>

<!-- number_decimal -->
<span class="metafield-number_decimal">8.4</span>

<!-- number_integer -->
<span class="metafield-number_integer">3</span>

<!-- page_reference -->
<a href="/pages/potion-dosages" class="metafield-page_reference">Potion dosages</a>

<!-- product_reference -->
<a href="/products/dried-chamomile" class="metafield-product_reference">Dried chamomile</a>

<!-- rating -->
<span class="metafield-rating">4.5</span>

<!-- single_line_text_field -->
<span class="metafield-single_line_text_field">Take with a meal.</span>

<!-- url -->
<a href="https://www.canada.ca/en/health-canada/services/food-nutrition/legislation-guidelines/acts-regulations/canada-food-drugs.html" class="metafield-url">www.canada.ca/en/health-canada/services/food-nutrition/legislation-guidelines/acts-regulations/canada-food-drugs.html</a>

<!-- variant_reference -->
<a href="/products/health-potion?variant=39897499762753" class="metafield-variant_reference">S / Medium</a>

<!-- rich_text_field -->
<div class="metafield-rich_text_field"><h3>Are you low on health? Well we&#39;ve got the potion just for you!</h3><p>Just need a top up? Almost dead? In between? No need to worry because we have a range of sizes and strengths!</p></div>
Anchor to Complex types

Complex types

The following metafield types return nested elements, or different elements depending on the metafield contents:

Anchor to dimension

dimension

Outputs a <span> element with the following attribute:

AttributeValue
classmetafield-dimension

The <span> element contains the following child elements:

Child elementHTML elementAttributes
The dimension value.

If it's a decimal with more than two places, then it'll be formatted to have a precision of two with trailing zeros removed.		<span>class="metafield-dimension_value"
The dimension unit.<span>class="metafield-dimension_unit"
{{ product.metafields.details.scale_width | metafield_tag }}

Output

<span class="metafield-dimension"><span class="metafield-dimension_value">3 </span><span class="metafield-dimension_unit">cm</span></span>
Anchor to file_reference

file_reference

The output varies depending on the type of file. There are the following categories of file type:

File typeDescription
ImageImages in the format of jpg, png, gif, heic, and webp.
VideoVideos in the format of mov, and mp4.
OtherAny other file type.
Image

Outputs an <img> element with the following attributes:

AttributeValue
srcThe image's URL.
altThe image's alt text.
classmetafield-file_reference
Video

Outputs a <video> element with the following attributes:

AttributeValue
srcThe video's URL.
posterThe video's preview image (poster) URL.
playsinlineN/A - Indicates the video will be played "inline" within the element's playback area.
preloadmetadata - Only metadata is pre-fetched before the video is played.

The <video> element contains the following child elements:

Child elementHTML elementAttributes
The video's multimedia playlist source, for HTTP live streaming (HLS)<source>src="<the video's m3u8 source URL>"

type="application/x-mpegURL"
The video's original source<source>src="<the video's source URL>"

type="<the video's original source MIME type>"
The video's preview (poster) image<img>src="<the video's preview image URL>"
Other

Outputs an <a> element with a link to the file and the following attribute:

AttributeValue
classmetafield-file_reference

The <a> element contains an <img> element for the file's preview image with the following attributes:

AttributeValue
srcThe file's preview image URL.
loadinglazy - The image isn't loaded until it's almost in view.
<!-- Image -->
{{ product.metafields.information.promo_image | metafield_tag }}

<!-- Video -->
{{ product.metafields.information.promo_video | metafield_tag }}

<!-- Other -->
{{ product.metafields.information.disclaimers | metafield_tag }}

Output

<!-- Image -->
<img src="//polinas-potent-potions.myshopify.com/cdn/shop/files/potions-header.png?v=1650325393" loading="lazy" class="metafield-file_reference">

<!-- Video -->
<video playsinline="playsinline" preload="metadata" poster="//polinas-potent-potions.myshopify.com/cdn/shop/files/preview_images/4733c31cd9d744f6994f61458fda85e6.thumbnail.0000000_small.jpg?v=1655257099"><source src="//polinas-potent-potions.myshopify.com/cdn/shop/videos/c/vp/4733c31cd9d744f6994f61458fda85e6/4733c31cd9d744f6994f61458fda85e6.HD-1080p-7.2Mbps.mp4?v=0" type="video/mp4"><img src="//polinas-potent-potions.myshopify.com/cdn/shop/files/preview_images/4733c31cd9d744f6994f61458fda85e6.thumbnail.0000000_small.jpg?v=1655257099"></video>

<!-- Other -->
<a href="//polinas-potent-potions.myshopify.com/cdn/shop/files/disclaimer.pdf?v=9043651738044769859" class="metafield-file_reference"><img src="//polinas-potent-potions.myshopify.com/cdn/shop/files/preview_images/document-7f23220eb4be7eeaa6e225738b97d943f22e74367cd2d7544fc3b37fb36acd71.png?v=1653087800" loading="lazy"></a>
Anchor to list.metaobject_reference

list.metaobject_reference

metafield | metafield_tag: field: string

Outputs a <ul> element by default with the following attribute:

AttributeValue
classmetafield-single_line_text_field-array

The <ul> element contains an <li> element for each metaobject in the list with a class of metafield-single_line_text_field. The required field parameter specifies which field should be rendered for each metaobject. The field parameter can reference only metafields of type single_line_text_field.

To output an <ol> element, pass the list_format parameter with a value of ordered.

<!-- <ul> element -->
{{ product.metafields.information.ingredients | metafield_tag: field: 'name' }}

<!-- <ol> element -->
{{ product.metafields.information.ingredients | metafield_tag: field: 'name', list_format: 'ordered' }}

Output

<!-- <ul> element -->
<ul class="metafield-single_line_text_field-array"><li class="metafield-single_line_text_field">Spinach</li><li class="metafield-single_line_text_field">Kale</li><li class="metafield-single_line_text_field">Mushrooms</li></ul>

<!-- <ol> element -->
<ol class="metafield-single_line_text_field-array"><li class="metafield-single_line_text_field">Spinach</li><li class="metafield-single_line_text_field">Kale</li><li class="metafield-single_line_text_field">Mushrooms</li></ol>
Anchor to list.single_line_text_field

list.single_line_text_field

Outputs a <ul> element by default with the following attribute:

AttributeValue
classmetafield-single_line_text_field-array

The <ul> element contains an <li> element for each item in the list with a class of metafield-single_line_text_field.

To output an <ol> element, pass the list_format parameter with a value of ordered.

<!-- <ul> element -->
{{ product.metafields.information.pickup_locations | metafield_tag }}

<!-- <ol> element -->
{{ product.metafields.information.pickup_locations | metafield_tag: list_format: 'ordered' }}

Output

<!-- <ul> element -->
<ul class="metafield-single_line_text_field-array"><li class="metafield-single_line_text_field">Ottawa</li><li class="metafield-single_line_text_field">Toronto</li><li class="metafield-single_line_text_field">Montreal</li><li class="metafield-single_line_text_field">Vancouver</li></ul>

<!-- <ol> element -->
<ol class="metafield-single_line_text_field-array"><li class="metafield-single_line_text_field">Ottawa</li><li class="metafield-single_line_text_field">Toronto</li><li class="metafield-single_line_text_field">Montreal</li><li class="metafield-single_line_text_field">Vancouver</li></ol>
Anchor to metaobject_reference

metaobject_reference

metafield | metafield_tag: field: string

Outputs an HTML element for the metaobject field specified by the required field parameter. The field parameter can reference only metafields of type single_line_text_field.

{{ product.metafields.information.primary_ingredient | metafield_tag: field: 'name' }}

Output

<span class="metafield-single_line_text_field">Spinach</span>
Anchor to volume

volume

Outputs a <span> element with the following attribute:

AttributeValue
classmetafield-volume

The <span> element contains the following child elements:

Child elementHTML elementAttributes
The volume value.

If it's a decimal with more than two places, then it'll be formatted to have a precision of two with trailing zeros removed.		<span>class="metafield-volume_value"
The volume unit.<span>class="metafield-volume_unit"
{{ product.metafields.details.milk_container_volume | metafield_tag }}

Output

<span class="metafield-volume"><span class="metafield-volume_value">500 </span><span class="metafield-volume_unit">mL</span></span>
Anchor to weight

weight

Outputs a <span> element with the following attribute:

AttributeValue
classmetafield-weight

The <span> element contains the following child elements:

Child elementHTML elementAttributes
The weight value.

If it's a decimal with more than two places, then it'll be formatted to have a precision of two with trailing zeros removed.		<span>class="metafield-weight_value"
The weight unit.<span>class="metafield-weight_unit"
{{ product.metafields.details.chamomile_base_weight | metafield_tag }}

Output

<span class="metafield-weight"><span class="metafield-weight_value">50 </span><span class="metafield-weight_unit">g</span></span>
Was this page helpful?