Introduction

Liquid The liquid is an open-source template language created by Shopify and written in Ruby. It is the backbone of Shopify themes and is used to load dynamic content on storefronts.

In MailUp Liquid is used as a markup language for the email messages that use the use Advanced content personalization.

...

Note

In the liquid syntax, not all characters are supported in a variable name. To be sure to have a correct syntax when using MailUp dynamic field, we recommend to use using only:

digits (0...9)
letters (a...z and A...Z)
dash (-) and underscore (_) signs

For MailUp Recipient fields that contain these characters:

accented characters should be substitute substituted with normalized character characters (e.g. 'CrèmeBrûlée' -> 'CremeBrulee')
special characters, such as full stop (.), space (' '), dollar('$'), should be removed from the field name (e.g. 'Is a colleague' -> 'Isacolleague').

...

Operator

Meaning

Work

Syntax

==

equals

This operator can be used with dynamic fields 'as is' only to compare strings.

Code Block

language	xml

{% if dynamicfields.name == 'alan' %} 
alan
{% elsif dynamicfields.name == 'tom' %}
tom
{% else %}
catherine
{% endif %}

In this case, the check is case-sensitive.

To compare numbers or data type types different from a string it is possible to use the built-in functions:

Code Block

language	xml

{% assign c1 = dynamicfields.name| evaltext: 'equalTo', 'Jennifer' %} {% if c1 == true %} Text {% endif %}

Code Block

language	xml

{% assign c1 = dynamicfields.age | evalinteger: 'equalTo', '8' %} {% if c1 == true %} Text {% endif %}

!=

does not equal

It is possible to use this operator with dynamic fields 'as is' only to compare strings.

Code Block

language	xml

{% if dynamicfields.name != 'alan' %} 
alan
{% elsif dynamicfields.name != 'tom' %}
tom
{% else %}
catherine
{% endif %}

In this case, the check is case-sensitive.

To compare numbers or data type types different from a string it is possible to use the built-in functions:

Code Block

language	xml

{% assign c1 = dynamicfields.name| evaltext: 'otherThan', 'Jennifer' %} {% if c1 == true %} Text {% endif %}

Code Block

language	xml

{% assign c1 = dynamicfields.age | evalinteger: 'otherThan', '8' %} {% if c1 == true %} Text {% endif %}

>

greater than

It is possible to use this operator with dynamic fields 'as is' only to compare strings.

Code Block

language	xml

{% if dynamicfields.name > 'alan' %} 
alan
{% elsif dynamicfields.name > 'tom' %}
tom
{% else %}
catherine
{% endif %}

In this case, the check is case-sensitive.

To compare numbers or data type types different from a string it is possible to use the built-in functions:

Code Block

language	xml

{% assign c1 = dynamicfields.name| evaltext: 'moreThan', 'Jennifer' %} {% if c1 == true %} Text {% endif %}

Code Block

language	xml

{% assign c1 = dynamicfields.age | evalinteger: 'moreThan', '8' %} {% if c1 == true %} Text {% endif %}

<

less than

It is possible to use this operator with dynamic fields 'as is' only to compare strings.

Code Block

language	xml

{% if dynamicfields.name < 'alan' %} 
alan
{% elsif dynamicfields.name < 'tom' %}
tom
{% else %}
catherine
{% endif %}

In this case, the check is case-sensitive.

To compare numbers or data type types different from a string it is possible to use the built-in functions:

Code Block

language	xml

{% assign c1 = dynamicfields.name| evaltext: 'lessThan', 'Jennifer' %} {% if c1 == true %} Text {% endif %}

Code Block

language	xml

{% assign c1 = dynamicfields.age | evalinteger: 'lessThan', '8' %} {% if c1 == true %} Text {% endif %}

>=

greater than or equal to

It is possible to use this operator with dynamic fields 'as is' only to compare strings.

Code Block

language	xml

{% if dynamicfields.name >= 'alan' %} 
alan
{% elsif dynamicfields.name >= 'tom' %}
tom
{% else %}
catherine
{% endif %}

In this case, the check is case-sensitive.

To compare numbers or data type types different from a string it is possible to use the built-in functions:

Code Block

language	xml

{% assign c1 = dynamicfields.name| evaltext: 'equalOrMoreThan', 'Jennifer' %} {% if c1 == true %} Text {% endif %}

Code Block

language	xml

{% assign c1 = dynamicfields.age | evalinteger: 'equalOrMoreThan', '8' %} {% if c1 == true %} Text {% endif %}

<=

less than or equal to

It is possible to use this operator with dynamic fields 'as is' only to compare strings.

Code Block

language	xml

{% if dynamicfields.name <= 'alan' %} 
alan
{% elsif dynamicfields.name <= 'tom' %}
tom
{% else %}
catherine
{% endif %}

In this case, the check is case-sensitive.

To compare numbers or data type types different from a string it is possible to use the built-in functions:

Code Block

language	xml

{% assign c1 = dynamicfields.name| evaltext: 'equalOrLessThan', 'Jennifer' %} {% if c1 == true %} Text {% endif %}

Code Block

language	xml

{% assign c1 = dynamicfields.age | evalinteger: 'equalOrLessThan', '8' %} {% if c1 == true %} Text {% endif %}

or

logical or

Code Block

language	xml

{% if dynamicfields.name == 'alan' or dynamicfields.age == 'child' %} 
is alan or a child
{% else %}
It is an adult alan or another adult
{% endif %}

and

logical and

Code Block

language	xml

{% if dynamicfields.name == 'alan' and dynamicfields.age == 'child' %} 
alan is a child
{% else %}
it is an adult
{% endif %}

contains

checks for the presence of a substring inside a string

Code Block

language	xml

{% if dynamicfields.name contains 'oof' %} 
could be alan? 
{% else %} 
surely isn't alan 
{% endif %}

...

Type Meaning Work Syntax

String

Declare a string by wrapping a variable’s value in single quotes:

Code Block

language	xml
title	Input

{% assign thisIsAString = 'this is a string' %}
{{ thisIsAString | upcase }}

Code Block

language	xml
title	Output

THIS IS A STRING

Number

Numbers include floats and integers:

Code Block

language	xml
title	Input

{% assign thisIsAnInteger = 10 %}
{{ thisIsAnInteger | minus: 2 }}

Code Block

language	xml
title	Output

Code Block

language	xml
title	Input

{% assign thisIsAFloat = 10.234 %}
{{ thisIsAFloat  | minus: 2 }}

Code Block

language	xml
title	Output

8.23400020599365

Boolean

Code Block

language	xml
title	Input

{% assign thisIsTrue = true %}
{{ thisIsTrue }}

Code Block

language	xml
title	Output

true

Code Block

language	xml
title	Input

{% assign thisIsFalse = true %}
{{ thisIsFalse }}

Code Block

language	xml
title	Output

false

Nil

Nil is a special empty value that is returned when the Liquid code has no results. It is not a string with the characters “nil”.

Nil is treated as false in the conditions of if blocks and other Liquid tags that check the truthfulness of a statement.

Code Block

language	xml
title	Input

{% if user %}
  Hello user!
{% endif %}

Code Block

language	xml
title	Output

 Hello user!

Code Block

language	xml
title	Input

{% unless user %}
  Hello user!
{% endunless %}

Code Block

language	xml
title	Output

 Hello user!

Array

Arrays hold lists of variables of any type.

Code Block

language	xml
title	Input

{% assign my_array = 'alan,catherine,tom,erin,mark' | split: ',' %}
{{ my_array.first }}
{{ my_array.last }}

Code Block

language	xml
title	Output

alan
mark

Code Block

language	xml
title	Input

{% assign my_array = 'alan,catherine,tom,erin,mark' | split: ',' %}
{% for user in my_array %}
 {{ user }}
{% endfor %}

Code Block

language	xml
title	Output

alan catherine tom erin mark

Code Block

language	xml
title	Input

{% assign my_array = 'alan,catherine,tom,erin,mark' | split: ',' %}
{{ my_array[2] }}

Code Block

language	xml
title	Output

tom

...

Operator Meaning Work Syntax

comment

Any text within the opening and closing comment blocks will not be output, and any Liquid code within will not be executed

Code Block

language	xml
title	Input

Text 1 {% comment %} Text 2 {% endcomment %}

Code Block

language	xml
title	Output

Text 1

...

Operator Meaning Work Syntax

if

Executes a block of code only if a certain condition is true

Code Block

language	xml
title	Input

{% assign c1 = dynamicfields.age| evalinteger: 'equalTo', '10' %} 
{% if c1 == true %} 
10 years old 
{% endif %}

Code Block

language	xml
title	Output

10 years old

Code Block

language	xml
title	Input

{% if dynamicfields.name == 'alan' %} 
alan
{% endif %}

Code Block

language	xml
title	Output

alan

unless

Executes a block of code only if a certain condition is not match

Code Block

title	Input

{% assign c1 = dynamicfields.age| evalinteger: 'equalTo', '10' %} 
{% unless c1 == true %} 
Not 10 years old
{% endunless %}

Code Block

language	xml
title	Output

Not 10 years old

Code Block

language	xml
title	Input

{% unless dynamicfields.name == 'alan' %} 
alan
{% endunless %}

Code Block

language	xml
title	Output

alan

elsif/else

Adds more conditions within an if or unless block.

Code Block

language	xml
title	Input

{% if dynamicfields.name == 'alan' %} 
alan
{% elsif dynamicfields.name == 'tom' %}
tom
{% else %}
catherine
{% endif %}

Code Block

language	xml
title	output if name is goofy

alan

Code Block

language	xml
title	output if name is tom

tom

Code Block

language	xml
title	output for each other name

catherine

case/when

Creates a switch statement to compare a variable with different values

Code Block

title	Input

{% case dynamicfields.name%}
  {% when 'alan' %}
     This is a alan
  {% when 'tom' %}
     This is a tom
  {% else %}
     This is not a alan nor a tom. can it be a catherine?
{% endcase %}

Code Block

language	xml
title	output if name is goofy

This is a alan

Code Block

language	xml
title	output if name is mickey

This is a tom

Code Block

language	xml
title	output for each other name

This is not a alan nor a tom. can it be a catherine?

...

Operator Meaning Work Syntax

assign

Creates a new variable

Code Block

language	xml
title	Input

{% assign c1 = 10 %}
{% if c1 == 10 %} 
    It is ten!
{% endif %}

Code Block

language	xml
title	Output

It is ten!

Code Block

language	xml
title	Input

{% assign c1 = 'alan' %}
{% if c1 == 'alan' %} 
   It is alan!
{% endif %}

Code Block

language	xml
title	Output

It is alan!

capture

Captures the string inside of the opening and closing tags and assigns it to a variable. Variables created through {% capture %} are strings.

Code Block

language	xml
title	Input

{% assign name = dynamicfields.name %}
{% assign surname = dynamicfields.surname %}

{% capture about_me %}
I am {{ name }} {{ surname }} and my favorite food is pizza.
{% endcapture %}

{{ about_me }}

Code Block

language	xml
title	output

I am Catherine Martin and my favorite food is pizza.

increment Creates a new number variable, and increases its value by one every time it is called. The initial value is 0.

decrement Creates a new number variable, and decreases its value by one every time it is called. The initial value is -1.

Filters

Operator Meaning Work Syntax

abs

Returns the absolute value of a number.

append

Concatenates two strings and returns the concatenated value.

Code Block

title	Input

{{ "Hello " | append: "Carl" }}

Code Block

title	Output

Hello Carl

Code Block

title	Input

{{ "Welcome" | append: dynamicfields.name }}

Code Block

title	Output

Welcome Luke

Code Block

title	Input

{{ dynamicfields.name | append: " welcome!"}}

Code Block

title	Output

Luke welcome!

at_least

Limits a number to a minimum value.

at_most

Limits a number to a maximum value.

capitalize

Makes the first character of a string capitalized.

Code Block

title	Input

{{ "my great title" | capitalize }}

Code Block

title	Output

My great title

Code Block

title	Input

{{ dynamicfields.nome | capitalize }}

Code Block

title	Output

Luke

ceil

Rounds the input up to the nearest whole number. Liquid tries to convert the input to a number before the filter is applied.

compact

Removes any nil values from an array.

concat

Concatenates (joins together) multiple arrays. The resulting array contains all the items from the input arrays.

date Converts a timestamp into another date format. The format for this syntax is the same as strftime. The input uses the same format as Ruby’s Time.parse.

default Allows you to specify a fallback in case a value doesn’t exist. defaultwill show its value if the left side is nil, false, or empty.

divided_by

Divides a number by the specified number.

Does not work on dynamicfields.

Code Block

title	Input

{{ 16 | divided_by: 4 }}

Code Block

title	Output

Code Block

title	Input

{{ subTotal| divided_by: 4 }}

Code Block

title	Output

downcase

Makes each character in a string lowercase. It has no effect on strings which does not affect strings that are already all lowercase.

Code Block

title	Input

{{ "Parker Moore" | downcase }}

Code Block

title	Output

parker moore

Code Block

title	Input

{{ dynamicfields.nome | downcase}}

Code Block

title	Output

luke

escape

Escapes a string by replacing characters with escape sequences (so that the string can be used in a URL, for example). It doesn’t change strings that don’t have anything to escape.

escape_once

Escapes a string without changing existing escaped entities. It doesn’t change strings that don’t have anything to escape.

first

Returns the first item of an array.

Assuming the userid dynamicfield contains "1,2,3,4,5".

Code Block

title	Input

{% assign my_array = dynamicfields.userid | split: "," %}
{{ my_array.first }}

Code Block

title	Output

Code Block

title	Input

{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}
{{ my_array.first }}

Code Block

title	Output

apples

floor

Rounds a number down to the nearest whole number. Liquid tries to convert the input to a number before the filter is applied.

join

Combines the items in an array into a single string using the argument as a separator.

Assuming the userid dynamicfield contains "1,2,3,4,5".

Code Block

title	Input

{% assign my_array = dynamicfields.userid | split: "," %}
{{ my_array | join: " and " }}

Code Block

title	Output

1 and 2 and 3 and 4 and 5

Code Block

title	Input

{% assign beatles = "John, Paul, George, Ringo" | split: ", " %}
{{ beatles | join: " and " }}

Code Block

title	Output

John and Paul and George and Ringo

last

Returns the last item of an array.

Assuming the userid dynamicfield contains "1,2,3,4,5".

Code Block

title	Input

{% assign my_array = dynamicfields.userid | split: "," %}
{{ my_array.last}}

Code Block

title	Output

Code Block

title	Input

{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}

{{ my_array.last }}

Code Block

title	Output

plums

lstrip

Removes all whitespaces (tabs, spaces, and newlines) from the beginning of a string. The filter does not affect spaces between words.

map

Creates an array of values by extracting the values of a named property from another object.

Assuming the products contains:

Code Block

language	java

{
	"products": [{
		"title": "Product 1",
		"price": 100
	}, {
		"title": "Product 2",
		"price": 200
	}, {
		"title": "Product 3",
		"price": 300
	}]
}

Code Block

title	Input

{% assign all_titles = products | map: "title" %}

{% for item in all_titles %}
{{ item }}
{% endfor %}

Code Block

title	Output

Product 1
Product 2
Product 3

minus

Subtracts a number from another number.

Does not work on dynamicfields.

Code Block

title	Input

{{ 4 | minus: 2 }}

Code Block

title	Output

Code Block

title	Input

{{ SubTotal | minus: 100 }}

Code Block

title	Output

modulo

Returns the remainder of a division operation.

Does not work on dynamicfields.

Code Block

title	Input

{{ 3 | modulo: 2 }}

Code Block

title	Output

Code Block

title	Input

{{ SubTotal | modulo: 6}}

Code Block

title	Output

newline_to_br

Replaces every newline (\n) with an HTML line break (<br>).

plus

Adds a number to another number.

Assuming the TotalIncome dynamic field contains 500.

Code Block

title	Input

{{ dynamicfields.TotalIncome| plus: 2 }}

Code Block

title	Output

Code Block

title	Input

{{ 5| plus: 2 }}

Code Block
7

prepend

Adds the specified string to the beginning of another string.

Code Block

title	Input

{{ "apples, oranges, and bananas" | prepend: "Some fruit: " }}

Code Block

title	Output

Some fruit: apples, oranges, and bananas

Code Block

title	Input

{{ dynamicfields.Name| prepend: "Hello " }}

Code Block

title	Output

Hello Luke

Code Block

title	Input

{{ dynamicfields.Name| prepend: dynamicfields.Surname}}

Code Block

title	Output

Luke Skywalker

Code Block

title	Input

{{ "Welcome" | prepend: dynamicfields.Name }}

Code Block

title	Output

Welcome Luke

remove

Removes every occurrence of the specified substring from a string.

Code Block

title	Input

{{ "I strained to see the train through the rain" | remove: "rain" }}

Code Block

title	Output

I sted to see the t through the

Code Block

title	Input

{{ dynamicfields.Name| remove: "uk"}}

Code Block

title	Output

Le

Code Block

title	Input

{{"Luke Skywalker" | remove: dynamicfields.Name}}

Code Block

title	Output

Skywalker

remove_first

Removes only the first occurrence of the specified substring from a string.

Code Block

title	Input

{{ "I strained to see the train through the rain" | remove_first: "rain" }}

Code Block

title	Output

I sted to see the train through the rain

replace

Replaces every occurrence of an argument in a string with the second argument.

Code Block

title	Input

{{ "Take my protein pills and put my helmet on" | replace: "my", "your" }}

Code Block

title	Output

Take your protein pills and put your helmet on

replace_first

Replaces only the first occurrence of the first argument in is a string with the second argument.

Code Block

title	Input

{% assign my_string = "Take my protein pills and put my helmet on" %}
{{ my_string | replace_first: "my", "your" }}

Code Block

title	Output

Take your protein pills and put my helmet on

reverse

Reverses the order of the items in an array. reverse cannot reverse a string.

round

Rounds an input number to the nearest integer or, if a number is specified as an argument, to that number of decimal places.

Does not work on dynamicfields.

Code Block

title	Input

{{ 1.2 | round }}

Code Block

title	Output

rstrip

Removes all whitespace (tabs, spaces, and newlines) from the right side of a string.

size

Returns the number of characters in a string or the number of items in an array. size can also be used with dot notation (for example, {{ my_string.size }}). This allows you to use size inside tags such as conditionals.

Code Block

title	Input

{{ "Ground control to Major Tom." | size }}

Code Block

title	Output

Code Block

title	Input

{% assign my_array = "apples, oranges, peaches, plums" | split: ", " %}

{{ my_array | size }}

Code Block

title	Output

slice

Returns a substring of 1 character beginning at the index specified by the argument passed in. An optional second argument specifies the length of the substring to be returned.

String indices are numbered starting from 0.

Code Block

title	Input

{{ "Liquid" | slice: 0 }}

Code Block

title	Output

Assuming title contains "Return to the future"

Code Block

title	Input

{{title | slice: 0}}

Code Block

title	Output

Code Block

title	Input

{{ dynamicfields.title| slice: 0 }}

Code Block

title	Outuput

sort

Sorts items in an array by a property of an item in the array. The order of the sorted array is case-sensitive.

Same behaviour behavior of the sort_natural filter.

Code Block

title	Input

{% assign my_array = "zebra, octopus, giraffe, Sally Snake" | split: ", " %}

{{ my_array | sort_natural | join: ", " }}

Code Block

title	Output

giraffe, octopus, Sally Snake, zebra

sort_natural Sorts items in an array by a property of an item in the array.

split

Divides an input string into an array using the argument as a separator. split is commonly used to convert comma-separated items from a string to an array.

Code Block

title	Input

{% assign beatles = "John, Paul, George, Ringo" | split: ", " %}
{% for member in beatles %}
{{ member }}
{% endfor %}

Code Block

title	Output

John

Paul

George

Ringo

Assuming the dynamic field albumid contains "1,2,3,4,5"

Code Block

title	Input

{% assign ids= dynamicfields.albumid | split: "," %}
{% for id in ids%}
{{ id }}
{% endfor %}

Code Block

title	Output

strip

Removes all whitespace (tabs, spaces, and newlines) from both the left and right side sides of a string. It does not affect spaces between words.

strip_html

Removes any HTML tags from a string.

Code Block

title	Input

{{ "Have <em>you</em> read <strong>Ulysses</strong>?" | strip_html }}

Code Block

title	Output

Have you read Ulysses?

strip_newlines

Removes any newline characters (line breaks) from a string.

times

Multiplies a number by another number.

Does not work on dynamicfields.

Code Block

title	Input

{{ 24 | times: 7 }}

Code Block

title	Output

truncate

truncate shortens a string down to the number of characters passed as a parameter. If the number of characters specified is less than the length of the string, an ellipsis (…) is appended to the string and is included in the character count.

Code Block

title	Input

{{ "Ground control to Major Tom." | truncate: 20 }}

Code Block

title	Output

Ground control to...

Code Block

title	Input

{{ "Ground control to Major Tom." | truncate: 25, ", and so on" }}

Code Block

title	Output

Ground control, and so on

truncatewords

Shortens a string down to the number of words passed as the argument. If the specified number of words is less than the number of words in the string, an ellipsis (…) is appended to the string.

uniq

Removes any duplicate elements in an array.

upcase

Makes each character in a string uppercase. It has no effect on strings which does not affect strings that are already all uppercase.

Code Block

title	Input

{{ dynamicfields.name | upcase }}

Code Block

title	Output

LUKE

url_decode

Decodes a string that has been encoded as a URL or by url_encode.

url_encode

Converts any URL-unsafe characters in a string into percent-encoded characters.

...

Versions Compared

Old Version 48

New Version Current

Key

Introduction

Filters

Page Comparison

Versions Compared

Old Version 48

New Version Current

Key

Filters