FilterReference

From Shopify Wiki

Jump to: navigation, search

See section UsingLiquid for an explanation on how to use filters!

These are the filters that you can use in Shopify liquid templates:

These are the filters that are generally available for Liquid:

Contents

escape(input)

Use this filter to escape a string.

Example: 

@   {{ link.title | escape }}  @

append(input)

Use this filter to append characters to a string.

Example: 

@   {{ 'sales' | append: '.jpg' }} #=> sales.jpg @

prepend(input)

Use this filter to prepend characters to a string.

size(input)

Return the size of an array or string

Example: 

@   {{ 'this is an 30 character string' | size }} #=> 30 @

join(input, segmenter = ' ')

"joins" an array with the specified character. Example: 

@   {{ product.tags | join: ', ' }} #=> wooden, deepsnow, season2006 @

downcase(input)

convert a input string to 'downcase'

upcase(input)

convert a input string to UPCASE

strip_html(text)

This will strip all html tags from the text passed to the block. Very useful in combination with truncate.

strip_newlines

Removes all newlines from the input

truncate(input, characters = 100)

Truncate a string down to x characters. Take care with truncating text which has html elements in it. In these cases you probably want to run the string through the strip_html filter first (see below).

truncatewords(input, words = 15)

Truncate string down to x words

date(input, format)

Reformat a date 

%a - The abbreviated weekday name (``Sun'')

%A - The  full  weekday  name (``Sunday'')

%b - The abbreviated month name (``Jan'')

%B - The  full  month  name (``January'')

%c - The preferred local date and time representation

%d - Day of the month (01..31)

%H - Hour of the day, 24-hour clock (00..23)

%I - Hour of the day, 12-hour clock (01..12)

%j - Day of the year (001..366)

%m - Month of the year (01..12)

%M - Minute of the hour (00..59)

%p - Meridian indicator (``AM''  or  ``PM'')

%S - Second of the minute (00..60)

%U - Week  number  of the current year,
        starting with the first Sunday as the first
        day of the first week (00..53)

%W - Week  number  of the current year,
         starting with the first Monday as the first
         day of the first week (00..53)

%w - Day of the week (Sunday is 0, 0..6)

%x - Preferred representation for the date alone, no time

%X - Preferred representation for the time alone, no date

%y - Year without a century (00..99)

%Y - Year with century

%Z - Time zone name

%% - Literal ``%'' character

first(array)

Get the first element of the passed in array

Example: 

<code>
{{ product.images | first | to_img }}
</code>

last(array)

Get the last element of the passed in array

Example: 

<code>
{{ product.images | last | to_img }}
</code>

newlines_to_br

Inserts a <br /> linebreak tag in front of every \n linebreak character.

replace(input, substring, replacement)

Will replace all occurrences of a string with another. 

{{ product.description | replace: 'super', 'mega' }}

replace_first(input, substring, replacement)

Will replace the first occurrence of a string with another. 

{{ product.description | replace_first: 'super', 'mega' }}


remove(input, substring)

Removes all occurrences of the substring from the input. 

{{ product.description | remove: 'way too expensive'}}

remove_first(input, substring)

Removes only the first occurrence of the substring from the input. 

{{ product.description | remove_first: 'remove-me'}}

plus(input, operand)

Gets the result of adding input to operand. When strings are passed, it parses strings as integers before adding.

Example: 

Showing {{ paginate.current_offset }}-{{ paginate.current_offset | plus: paginate.page_size }} items

minus(input, operand)

Gets the result of subtracting input from operand. When strings are passed, it parses strings as integers before adding.

Example: 

{{ product.price | minus: 10 | money_with_currency }}
Retrieved from "http://wiki.shopify.com/FilterReference"
Personal tools