This page contains definitions for all Mechanic-supported Liquid filters.

Filters that are unique to Mechanic (and not available in Shopify or on other platforms) are noted with an asterisk.

Data filters

base64, decode_base64 *

Allows for converting between strings and their base64-encoded representations.

{% assign json_safe_image = image | base64 %}
{% assign original_image = json_safe_image | decode_base64 %}

browser *

This filter converts a browser user agent string into an object that represents the browser itself. (This filter uses data from Browserscope to match user agents.

{% assign browser = "Mozilla/5.0 (iPhone; CPU iPhone OS 12_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) GSA/79.0.259819395 Mobile/16G77 Safari/604.1" | browser %}
​
{{ browser }}
​
name: {{ browser.name }}
​
version: {{ browser.version }}
major version: {{ browser.version.major }}
minor version: {{ browser.version.minor }}
​
os: {{ browser.os }}
os name: {{ browser.os.name }}
os version: {{ browser.os.version }}
os major version: {{ browser.os.version.major }}
os minor version: {{ browser.os.version.minor }}
​
device: {{ browser.device }}
device name: {{ browser.device.name }}
device brand: {{ browser.device.brand }}
device model: {{ browser.device.model }}

Google 79.0.259819395
​
name: Google
​
version: 79.0.259819395<br>major version: 79<br>minor version: 0
​
os: iOS 12.4<br>os name: iOS<br>os version: 12.4<br>os major version: 12<br>os minor version: 4
​
device: iPhone<br>device name: iPhone<br>device brand: Apple<br>device model: iPhone

csv, parse_csv *

Supports converting a two-dimensional array to a CSV string, and back again.

The parse_csv filter accepts a "headers" option; when set to true, this filter will interpret the first line of input as containing headers for the CSV table, and will return an array of hashes whose keys map to items in that header row.

{% capture two_dimensional_array_json %}
  [
    [
      "Order Name",
      "Order ID",
      "Order Date"
    ],
    [
      "#1234",
      1234567890,
      "2021/03/23"
    ],
    [
      "#1235",
      1234567891,
      "2021/03/24"
    ]
  ]
{% endcapture %}
​
{% assign two_dimensional_array = two_dimensional_array_json | parse_json %}
​
{% assign csv_string = two_dimensional_array | csv %}

{% comment %}
  Note the dashes used in the capture/endcapture tags!
  They make sure that we don't end up with blank lines
  at the beginning and end of our CSV string.
{% endcomment %}
{% capture csv_string -%}
Order Name,Order ID,Order Date
#1234,1234567890,2021/03/23
#1235,1234567891,2021/03/24
{%- endcapture %}
​
{% assign csv_rows = csv_string | parse_csv %}
​
{% assign orders = array %}
{% for row in csv_rows %}
  {% comment %}
    Skip the header row
  {% endcomment %}
  {% if forloop.first %}
    {% continue %}
  {% endif %}
​
  {% assign order = hash %}
  {% assign order["name"] = row[0] %}
  {% comment %}
    We're using `times: 1` to convert our string ID to an integer
  {% endcomment %}
  {% assign order["id"] = row[1] | times: 1 %}
  {% assign order["date"] = row[2] %}
​
  {% assign orders[orders.size] = order %}
{% endfor %}
​
{{ orders | json }}

{% comment %}
  Note the dashes used in the capture/endcapture tags!
  They make sure that we don't end up with blank lines
  at the beginning and end of our CSV string.
{% endcomment %}
{% capture csv_string -%}
Order Name,Order ID,Order Date
#1234,1234567890,2021/03/23
#1235,1234567891,2021/03/24
{%- endcapture %}
​
{% comment %}
  Note: the order ID is a string, in this resulting set of
  hashes, not an integer!
{% endcomment %}
{% assign orders = csv_string | parse_csv: headers: true %}
​
{{ orders | json }}
{% comment %}
  The result:
​
  [
    {
      "Order Name": "#1234",
      "Order ID": "1234567890",
      "Order Date": "2021/03/23"
    },
    {
      "Order Name": "#1235",
      "Order ID": "1234567891",
      "Order Date": "2021/03/24"
    }
  ]
{% endcomment %}

date, parse_date *

Mechanic's date filter is based on Shopify's date filter. Mechanic's implementation has all the functionality of Shopify's. It accepts a date format, using the same format as Ruby's strftime. (Sites like strfti.me offer convenient references for this format.) Under the hood, this filter uses ActiveSupport::TimeZone#strptime, and inherits its behavior with regard to missing upper components.

Choosing a timezone

Mechanic's date filter supports a tz option, which accepts a timezone name from the TZ database. If given, the resulting time string will be in the specified timezone. If this option is not provided, the store's local timezone will be used instead.

{{ "now" | date: "%Y-%m-%d %H:%M %z" }}
=> "2019-01-01 09:00 +0900"
​
{{ "now" | date: "%Y-%m-%d %H:%M %z", tz: "UTC" }}
=> "2019-01-01 00:00 +0000"

Using the current time

This filter also accepts the special value "now", and values offset from now, as in "now + 5 days" or "now - 5 weeks". In this way, the filter supports simple date math. Note that durations are calculated using variable duration lengths, given the naturally varying length of specific days, weeks, months, and years, given DST and other calendar variances, all informed by the store's timezone. This math is backed by ActiveSupport::TimeWithZone#+. An example, quoting from that documentation: "a time + 24.hours will advance exactly 24 hours, while a time + 1.day will advance 23-25 hours, depending on the day".

{{ "now + 6 weeks" | date: "%Y-%m-%d %H:%M %z" }}
{{ "now + 3 months" | date: "%Y-%m-%d %H:%M %z" }}
{{ "now - 3 months" | date: "%Y-%m-%d %H:%M %z" }}
​
=> "2021-02-15 14:06 -0500"
=> "2021-04-04 14:06 -0400"
=> "2020-10-04 14:06 -0400"

Parsing dates

Use parse_date to parse a date string, when its exact format is known. This filter is useful for strings that contain an ambiguous date value, like "01/01/01".

This filter returns an ISO8601 string, representing the parsed date value in the store's local timezone. If the supplied date string cannot be parsed successfully, the filter will return nil.

{{ "01-01-20" | parse_date: "%m-%d-%y" }}
=> "2020-01-01T00:00:00+11:00"
​
{{ "01-01-20" | parse_date: "%m-%d-%y" | date: "%Y-%m-%d" }}
=> "2020-01-01"
​
{{ "ab-cd-ef" | parse_date: "%m-%d-%y" }}
=> nil

default

Returns either the input value, or – if the input is either nil, false, or an empty string "" – it returns its argument.

Howdy {{ order.shipping_address.first_name | default: "partner" }}

gzip, gunzip *

These filters allow you to compress and decompress strings, using gzip compression.

In general, all strings passing through Mechanic must be UTF-8, and must ultimately be valid when represented as JSON. However, because gzip'd content may not be UTF-8, and because it may be important to preserve the original encoding, the gunzip filter supports a force_utf8: false option. Use this when you're certain the original encoding must be preserved, if you ultimately intend to pass along the string in a JSON-friendly representation. (For example, you might gunzip a value, and then use the base64 filter to represent it safely within JSON.)

{{ "testing" | gzip | gunzip }}
=> "testing"
​
{{ "hello world" | gzip | base64 }}
=> "H4sIABwbfl8AA8tIzcnJVyjPL8pJAQCFEUoNCwAAAA=="
​
{{ "H4sIANAafl8AA8tIzcnJVyjPL8pJAQCFEUoNCwAAAA==" | decode_base64: force_utf8: false | gunzip }}
=> "hello world"
​
{% assign base64_non_utf8_string = "H4sIACP1fV8AAyvPSCxRSMlPLVbILFHITU3MUyjJV0hKVXjUMKc4J7/8UcNcewAYP+lTIwAAAA==" %}
{{ base64_non_utf8_string | decode_base64: force_utf8: false | gunzip: force_utf8: false }}
=> (a string that is not UTF-8, and cannot be exported to JSON as-is)
​
{% assign base64_non_utf8_string = "H4sIACP1fV8AAyvPSCxRSMlPLVbILFHITU3MUyjJV0hKVXjUMKc4J7/8UcNcewAYP+lTIwAAAA==" %}
{{ base64_non_utf8_string | decode_base64: force_utf8: false | gunzip }}
=> "what does it mean to be “slow”?"

graphql_arguments *

[todo]

img_url *

[todo]

json, parse_json, parse_jsonl *

Allows converting objects to their JSON representations, and parsing that JSON into hashes.

{% assign order_as_json = order | json }}
{% assign plain_order = order_as_json | parse_json %}

The parse_jsonl filter can be used to parse a series of JSON strings, each on their own line, into an array of hashes. Useful when preparing stub data for bulk operations.

{% capture jsonl_string %}
  {"id":"gid://shopify/Customer/12345","email":"[email protected]"}
  {"id":"gid://shopify/Customer/67890","email":"[email protected]"}
{% endcapture %}
​
{% assign json_objects = jsonl_string | parse_jsonl %}
​
{{ json_objects | map: "email" | join: ", " }}

parse_xml *

Use this filter to parse an XML string. (Under the hood, this filter calls Hash::from_xml.) Useful for processing output from third-party APIs, either by responding to "http" actions, or by parsing content from inbound webhooks.

{% capture xml_string %}
<foo>
  <bar>baz</bar>
  <bar>
    <qux>quux</qux>
  </bar>
</foo>
{% endcapture %}
​
{% assign xml = xml_string | parse_xml %}
​
{{ xml | json }}

{"foo":{"bar":["baz",{"qux":"quux"}]}}

shopify *

[todo]

String filters

Mechanic supports

append

{{ 'report' | append: '.pdf' }}

report.pdf

capitalize

{{ 'mechanic' | capitalize }}

Mechanic

downcase, upcase

{{ 'stop yelling it at me' | upcase }}
{{ 'STOP YELLING AT ME' | downcase }}

STOP YELLING AT ME
stop yelling at me

e164 *

This filter accepts a phone number – country code is required! – and outputs it in standard E.164 format. If the number does not appear valid, the filter returns nil.

{{ "1 (312) 456-7890" | e164 }}
=> "13124567890"
​
{{ "+43 670 1234567890" | e164 }}
=> "436701234567890"
​
{{ "000" | e164 | json }}
=> "null"

escape, escape_once

match *

Use this filter to match a string with a Ruby-compatible regular expression pattern (see Regexp).

This filter returns the entire matched string (i.e. MatchData#to_s). Use the "captures" or "named_captures" lookups to receive an array or hash of captures, respectively (i.e. MatchData#captures, MatchData#named_captures).

{{ "It's a lovely day!" | match: "(?<=a ).*(?= day)" }}
=> "lovely"
​
{% assign match = "It's a lovely day!" | match: "a (bucolic|lovely) day" %}
{{ match.captures }}
=> ["lovely"]
​
{% assign match = "It's a lovely day!" | match: "a (?<adjective>bucolic|lovely) day" %}
{{ match.named_captures }}
=> {"adjective"=>"lovely"}
​
{% assign match = "It's a lovely day!" | match: "a (?i:LOVELY) day" %}
{{ match }}
=> "a lovely day"

md5

newline_to_br

prepend

{{ 'great to meet you.' | prepend: 'It was ' }}

It was geat to meet you

remove, remove_first

Removes a substring from a string.

{{ "Hi everyone! Nice to meet everyone!" | remove: "everyone" }}
{{ "Hi everyone! Nice to meet everyone!" | remove_first: "everyone" }}

Hi ! Nice to meet !
Hi ! Nice to meet everyone!

replace, replace_first

Replaces a substring with something else.

{{ "Matt and Megan love to travel and travel." | replace: 'travel', 'party' }}
{{ "Matt and Megan love to travel and travel | replace_first : 'travel', 'party' }}

Matt and Megan love to party and party.
Matt and Megan love to party and travel.

sha256, hmac_sha1, hmac_sha256

Generates SHA checksums of strings.

{% assign signature = "mechanic" | sha256 %}
sha256: {{ signature }}
​
{% assign signature = "mechanic" | hmac_sha1: "sincerely" %}
hmac_sha1: {{ signature }}
​
{% assign signature = "mechanic" | hmac_sha256: "sincerely" %}
hmac_sha256: {{ signature }}

sha256: 6c8a739536961bcf34dccc343908406d48139344da4754d4cfe43dcf8d662607
​
hmac_sha1: 0425a4dbbe0588be87fb51b5706c2244401bc73a
​
hmac_sha256: 4b8e2bcf66f95b21f74f491eacc1459b0c9ea6723355174af52ded391f9326ea

size

Returns the integer length of the input string.

slice

This filter accepts an integer offset, and an optional integer length (defaulting to 1). It returns a substring, beginning at the provided index, having the provided length.

Negative offsets begin counting from the end of the string.

{{ "12345" | slice: 3 }}
=> "4"
​
{{ "12345" | slice: 3, 2 }}
=> "45"
​
{{ "12345" | slice: -3, 2 }}
=> "34"

split

Takes a substring, and uses it to split a string into an array.

{% assign quote = "love,is,all,you,need!" | split: ',' %}
​
{% for word in quote %}
  {{ quote }}
{% endfor %}

love
is
all
you
need!

strip, lstrip, rstrip

The strip filter removes whitespace from both sides of a string. The lstrip filter removes whitespace from the left side; the rstrip filter removes whitespace from the right side.

{{ '   why do we have so many spaces?      ' | strip }}

why do we have so many spaces?

strip_html

strip_newlines

truncate, truncatewords

unindent *

Use this filter on strings to remove indentation from strings.

{% capture message %}
  Hello, friend!
  It's a mighty fine day!
{% endcapture %}
​
{{ message }}
{{ message | unindent }}

  Hello, friend!
  It's a mighty fine day!
​
​
Hello, friend!
It's a mighty fine day!

url_decode, url_encode

Number filters

currency *

Formats a number (given as an integer, float, or string) as currency. Called with no arguments, this filter uses the store's primary currency and default locale.

A three-character ISO currency code may be specified as the first argument; currency support is drawn from the money project. The locale may be overridden as a named option; locale support is drawn from rails-i18n.

{{ "100000.0" | currency }}
{{ 100000.0 | currency: "EUR" }}
{{ 100000 | currency: "EUR", locale: "fr" }}
{{ 100000 | currency: locale: "fr" }}

$100,000.00
€100,000.00
€100 000,00
$100 000,00

Note that this filter does not automatically append the currency ISO code (e.g. it will not generate output resembling "€100,000.00 EUR"). To add the ISO code manually, use one of these examples:

{{ price | currency }} {{ shop.currency }}
{{ price | currency | append: " " | append: shop.currency }}

Math filters

Mechanic supports the same set of math filters as Shopify.

• abs – Returns the absolute value of the input. No arguments.

• at_most – Accepts one argument; returns either the input or the argument, whichever is lesser.

• at_least – Accepts one argument; returns either the input or the argument, whichever is greater.

• ceil – Rounds a float to the next highest integer.

• divided_by – Accepts one argument; divides the input by the argument. If both the input and arguments are integers, returns an integer; otherwise, returns a float.

• floor – Rounds a float down to the next highest integer.

• minus – Accepts one argument; returns the input minus the argument.

• plus – Accepts one argument; returns the input plus the argument.

• round – Rounds a float to the nearest integer.

• times – Accepts one argument; divides the input by the argument. If both the input and arguments are integers, returns an integer; otherwise, returns a float.

• modulo – Accepts one argument; divides the input by the argument and returns the remainder.

Array filters

concat

Concatenates two arrays into a single array.

{% assign lunch = "sandwich, apple, soup" | split: ", " %}
{% assign dinner = "pasta, pizza, salad" | split: ", " %}
​
{% assign meals = lunch | concat: dinner %}
​
{{ meals | join: ", " }}
​
{% assign breakfast = "eggs, oatmeal, toast" | split: ", " %}
​
{% assign meals = breakfast | concat: lunch | concat: dinner %}
​
{{ meals | join: ", " }}

sandwich, apple, soup, pasta, pizza, salad
eggs, oatmeal, toast, sandwich, apple, soup, pasta, pizza, salad

first, last

Returns the first or last element of an array. You can use first or last in dot notation inside of tags.

{% comment %} 
  product.tags = "VIP", "New", "Canada"
{% endcomment %}
​
{{ custom.tags | first }}
{{ customer.tags | last }}
​
{% if customer.tags.first == "VIP" %}
  This customer is a VIP!
{% endif %
​
{% if customer.tags.last == "Canada" %}
  Eh!
{% endif %}

VIP
Canada
This customer is a VIP!
Eh!

in_groups *

This filter is an implementation of Array#in_groups. It accepts an array, and an integer count, and – optionally – a "fill_with" option.

{{ "1,2,3" | split: "," | in_groups: 2 | json }}

[["1","2"],["3",null]]

{{ "1,2,3" | split: "," | in_groups: 2, fill_with: false | json }}

[["1","2"],["3"]]

in_groups_of *

This filter is an implementation of Array#in_groups_of. It accepts an array, and an integer count, and – optionally – a "fill_with" option.

This filter is particularly useful when performing work in batches, by making it easy to split an array of potentially large size into smaller pieces of controlled size.

{{ "1,2,3,4,5" | split: "," | in_groups_of: 2 | json }}

[["1","2"],["3","4"],["5",null]]

{{ "1,2,3,4,5" | split: "," | in_groups_of: 2, fill_with: false | json }}

[["1","2"],["3","4"],["5"]]

index_by *

This filter accepts the name of an object property or attribute, and returns a hash that whose values are every element in the array, keyed by every element's corresponding property or attribute.

{% capture variants_json %}
  [
    {
      "id": 12345,
      "sku": "ONE"
    },
    {
      "id": 67890,
      "sku": "TWO"
    }
  ]
{% endcapture %}
​
{% assign variants = variants_json | parse_json %}
​
{{ variants | index_by: "sku" | json }}

{
  "ONE": {
    "id": 12345,
    "sku": "ONE"
  },
  "TWO": {
    "id": 67890,
    "sku": "TWO"
  }
}

join

Creates a string from the elements of an array using a character passed as an argument.

{% comment %} 
  product.tags = "VIP", "New", "Canada"
{% endcomment %}
​
{{ customer.tags | join: ', ' }}

VIP, New, Canada

map

Given an array of objects that contain attributes (e.g. name) and values (e.g. matt), we can use map to get a new array of values for a specific attribute of the objects in the array. In the below example, we have an array of products, and each product has a title. Using map we can create a new array of only product titles.

{% comment %} 
  product.titles = "Apple", "Orange", "Pepper", "Cheese"
{% endcomment %}
​
{% assign product_titles = products | map: 'title' %}
​
{{ product_titles }}

AppleOrangePepperCheese

push *

This filter appends any number of arguments onto the provided array, returning a new array, leaving the original unmodified.

{% assign count_to_three = "one,two,three" | split: "," %}
​
{% assign count_to_five = count_to_three | push: "four", "five" %}
​
{{ count_to_five | join: newline }}

one
two
three
four
five

reverse

This filter returns a new array, containing the contents of the original in reverse order.

sample *

This filter can be used on any array. Used without any arguments, it returns a single random element from the array. Provide an integer argument to return another array of that size, containing a random subset of the input array.

{{ "1,2,3" | split: "," | sample }}
=> "2"
​
{{ "1,2,3" | split: "," | sample: 2 | join: "," }}
=> "3,1"

slice

This filter accepts an integer offset, and an optional integer length (defaulting to 1). If the length is 1, it returns the single element found at that index of the input array. Otherwise, it returns a slice of the array, beginning at the provided index, having the provided length.

Negative offsets begin counting from the end of the array.

{{ "1,2,3,4,5" | split: "," | slice: 3 }}
=> "4"
​
{{ "1,2,3,4,5" | split: "," | slice: 3, 2 | join: "," }}
=> "4,5"
​
{{ "1,2,3,4,5" | split: "," | slice: -3, 2 | join: "," }}
=> "3,4"