Liquid Filters

Liquid Filters

Standard Filters

abs

Returns an absolute value of a number e.g. {% raw %}

 {{ -17 | abs }} }} #=> 17

{% endraw %}

append

append a string e.g. {% raw %}

 {{ 'foo' | append:'bar' }} #=> 'foobar'

{% endraw %}

capitalize

capitalize words in the input sentence

ceil

rounds a number up to the nearest integer, e.g. {% raw %}

 {{ 4.6 | ceil }} #=> 5

{% endraw %}

date

reformat a date (syntax reference)

default

returns the given variable unless it is null or the empty string, when it will return the given value, e.g. {% raw %}

 {{ undefined_variable | default: "Default value" }} #=> "Default value"

{% endraw %}

{% raw %}

 {{ product_price | default: 2.99 }} #=> 2.99

{% endraw %}

{% raw %}

 {% assign product_price = 4.99 %}
 {{ product_price | default: 4.99 }}  #=> 4.99

{% endraw %}

divided_by

integer division e.g. {% raw %}

 {{ 10 | divided_by:3 }} #=> 3

{% endraw %}

downcase

convert an input string to lowercase

escape_once

returns an escaped version of html without affecting existing escaped entities

escape

html escape a string

first

get the first element of the passed in array

floor

rounds a number down to the nearest integer, e.g. {% raw %}

 {{ 4.6 | floor }} #=> 4

{% endraw %}

join

join elements of the array with certain character between them

last

get the last element of the passed in array

lstrip

strips all whitespace from the beginning of a string

map

map/collect an array on a given property

minus

subtraction e.g. {% raw %}

 {{ 4 | minus:2 }} #=> 2

{% endraw %}

modulo

remainder, e.g. {% raw %}

 {{ 3 | modulo:2 }} #=> 1

{% endraw %}

newline_to_br

replace each newline (\n) with html break

plus

addition e.g. {% raw %}

 {{ '10' | plus:'1' }} #=> 11

{% endraw %}

prepend

prepend a string e.g. {% raw %}

 {{ 'bar' | prepend:'foo' }} #=> 'foobar'

{% endraw %}

remove_first

remove the first occurrence e.g. {% raw %}

 {{ 'barbar' | remove_first:'bar' }} #=> 'bar'

{% endraw %}

remove

remove each occurrence e.g. {% raw %}

 {{ 'foobarfoobar' | remove:'foo' }} #=> 'barbar'

{% endraw %}

replace_first

replace the first occurrence e.g. {% raw %}

 {{ 'barbar' | replace_first:'bar','foo' }} #=> 'foobar'

{% endraw %}

replace

replace each occurrence e.g. {% raw %}

 {{ 'foofoo' | replace:'foo','bar' }} #=> 'barbar'

{% endraw %}

reverse

reverses the passed in array

round

rounds input to the nearest integer or specified number of decimals e.g. {% raw %}

 {{ 4.5612 | round: 2 }} #=> 4.56

{% endraw %}

rstrip

strips all whitespace from the end of a string

size

return the size of an array or string

slice

slice a string. Takes an offset and length, e.g. {% raw %}

 {{ "hello" | slice: -3, 3 }} #=> llo

{% endraw %}

sort

sort elements of the array

split

split a string on a matching pattern e.g. {% raw %}

 {{ "a~b~c" | split:"~" }} #=> ['a','b', 'c']

{% endraw %}

{% raw %}

{% assign beatles = "Usage, Adoption, Retention, Renewal, Revenue Expansion" | split: ", " %}
    {% for member in beatles %}
    {{ member }}
{% endfor %}
#=>
Usage

Adoption

Retention

Renewal

Revenue Expansion

{% endraw %}

strip_html

strip html from string

strip_newlines

strip all newlines (\n) from string

strip

strips all whitespace from both ends of the string

times

multiplication e.g

{% raw %}

 {{ 5 | times:4 }} #=> 20

{% endraw %}

truncate

truncate a string down to x characters. It also accepts a second parameter that will append to the string e.g. {% raw %}

 {{ 'foobarfoobar' | truncate: 5, '.' }} #=> 'foob.'

{% endraw %}

truncatewords

truncate a string down to x words

uniq

removed duplicate elements from an array, optionally using a given property to test for uniqueness

upcase

convert an input string to uppercase

url_encode

url encode a string