Image

Image

{{ image }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published image
guid String The unique identifier for this image
value String Contains the same value as guid
name text The name of the image
title text The title of the image
linked_title String A link to the image if it has a URL, or the escaped title if not
alt text Alternative text for accessibility and when the image cannot be displayed
path String Full url of the uploaded image in the CDN
height Integer Pixel height of the image
width Integer Pixel width of the image
filesize Integer The image size in bytes
attribution textarea Attribution or credit text for the asset (e.g., photographer, source). The specific format of the attribution text is at the discretion of the editor
tags tags The list of tags associated with this image
authors authors The list of authors associated with this image
has_url Boolean True if the image has a URL
include_in_search Boolean Whether or not this image should be returned in on-site search results
domain_name text The domain name used by the URL for this image
url text The portion of the URL for this image following the domain name
full_url String The full URL for this image including the scheme, domain name, and path
visited Boolean Whether or not the user has visited this URL previously in their current session. Note that this will always be false if the user has not allowed session permission (see the Permissions and Personalization documentation). Using this property prevents the page from being fast-cached
template_guid String The unique identifier for the template that would be used to respond to this URL
template template The template that would be used to respond to this URL
canonical_url url The canonical URL if this is not the original source of content for this URL
browser_title text The browser title to use for this URL
meta_description textarea The meta description for this URL
meta_robots text The meta robots for this URL
keywords textarea The SEO keywords for this URL
search_entity_guid String The unique identifier for the entity that search results should be directed to (if this image does not have a URL)
search_entity entity The entity that search results should be directed to (if this image does not have a URL)
folder_guid String The unique identifier for the folder that contains this image.
folder folder The folder that contains this image.
field_id String The identifier for this field
label String The label for this field
output String The default output that the image produces when output directly to the template. The default output may change at any time. Template developers should avoid using this and should handle the output of images themselves
data data Object containing the custom fields on this image
* String Specific custom fields may be accessed using {{ entity.fieldid }} or {{image['field-id']}}

{{ images }}

Contains multiple images.

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this contains at least one published image
output String The default output that the images will produce when it is output directly to the template - using the "output_in_list" property of each image in the items list
prepended list List containing any prepended images.
fetched list List containing all of the images that were fetched from the database (as opposed to prepended or appended).
appended list List containing any appended images.
appended_unique list List containing any appended images excluding any images that are in either the list of prepended or fetched images.
items list List containing all of the combined images from the prepended, fetched, and appended lists. If unique is true, this list will not contain any duplicates. If max_size is set, this list will not contain more than the number of images specified.
size Integer The total number of images in the items list, including prepended, fetched, and appended lists, and respecting the unique and max_size properties.
max_size Integer If set, this is the maximum number of items that will be returned in the items list and the maximum number of items that will be included when this images object is enumerated as a list. When not set, this value will be 0.
unique Boolean When true, the items list will not contain any duplicates. Only the first instance of each image will be included.
limit Integer The maximum number of items that were allowed to be in the list of fetched images. May be 0 in some cases (such as when when there are no fetched images.
start Integer The 1-based index of the first item in the list of fetched images.
page Integer The 1-based index of the paginated results returned in the list of fetched images, which is calculated from the start and limit parameters. Useful for paginated results.
total_count Integer The 1-based index of the first item in the list of fetched images
total_pages Integer

{% image %}

{% image output_to_template? [var, set, or assign]? variable? output_to_template? = value %}

{% image
output_to_template
 
If included the image will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this image is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this image to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the image will be output directly to the template.
=
value
 
Should evaluate to a image object, or the name or guid of a image May use liquid filters.
%}
Fetches a single image.

{% images %}

{% images output_to_template? [var, set, or assign]? variable? output_to_template? = arguments %}

{% images
output_to_template
 
If included the images will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this images is stored on. "var" is the default behavior.
variable
output_to_template
 
If included the images will be output directly to the template.
=
arguments
 
Key:value pairs. May use the variable arguments syntax.
%}

arguments

prepend
 
May be a single image, a list of images, or the name or guid of a image to be be included at the beginning of the images.
append
 
May be a single image, a list of images, or the name or guid of a image to be be included at the end of the images.
exclude
 
May be a single image, a list of images, or the name or guid of a image that should NOT be included in the fetched results. Has no affect on prepended or appended images.
exclude_prepended
 
True to specifically exclude all prepended images from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.
exclude_appended
 
True to specifically exclude all appended images from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.
unique
 
True to remove duplicates from each of the resulting lists (prepended, fetched, appended, and items), although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.
max_size
 
The maximum number of items to be included in the "items" list. If there are any prepended or appended items, this will automatically lower the "limit" to only fetch as many images as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting images. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
filter
 
Only include images that match the given string filter
tag
 
May include multiple tags. Only include images with one of the given tags
author
 
May include multiple authors. Only include images with one of the given authors
folder
 
May include multiple folders. Only include images with one of the given folders
date_created_start
 
Only include images with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the image was first published.
date_created_end
 
Only include images with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the image was first published.
start
 
Set the 1-based index of the first image to fetch.
page
 
Used to automatically calculate the first image to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.
limit
 
The maximum number of images to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
sort_by
 
Specify which property to sort the results by. Has no affect on prepended or appended images. By default, results will be sorted by relevance if there is a filter string and date_created desc (newest first) if not. Options include:
  • relevance: only applies when there is a filter string. When sorting by relevance sort_direction is ignored.
  • date_created: the date each images was first published. Unpublishing and republishing a images resets date_created to the current date.
  • random: results will be returned in a random order, which prevents the page from being fast-cached. Setting cache_random:true overrides this behavior and allows the page to be fast-cached anyway.
  • name
  • title
  • url
  • browser_title
sort_direction
 
asc or desc.
cache_random
 
True to allow the results to be cached when sort_by is "random".
Fetches a list of images.

{% img %}

Shortcut to output a <img> tag for an image, optionally wrapped in a link.

{% img image attributes %}

{% img
value
 
Image object, guid, or name
attributes
 
Key:value pairs. May use the variable arguments syntax. Additional options for the image URL, img tag, and anchor tag (if applicable)
%}

attributes

preset
 
Zero or more image presets; may repeat or include space-separated list
link
 
If string, wraps image with anchor to that URL. If true and image has a URL (page), wraps to the image URL
class
 
Class attribute for the img tag. If included multiple times all of the classes will be included, separated by spaces
link_class
 
Class attribute for the wrapping anchor tag, if applicable. If included multiple times all of the classes will be included, separated by spaces
link_attribute
 
Additional attributes for the wrapping anchor tag, if applicable. Each attribute must be prefixed with "link_", may only be included once, and must have a value to be included in the anchor tag
other
 
Additional attributes for img tag. Each additional attribute may only be included once and must have a value to be included in the img tag

Examples

Img shortcut

Copy
Template: {% img page.featured_image link:true %}
Output: <a href="http://www.domain.com/path/to/image/page"><img src="http://www.domain.com/path/to/img.jpg" alt="Image Alt Text" title="Image Title" width="Image Width" height="Image Height" /></a>

Img shortcut advanced

Copy
Template: {% var property = 'data-attribute-x' %}
{% img page.featured_image link:false &property:'xyz' %}
Output: <img src="http://www.domain.com/path/to/img.jpg" alt="Image Alt Text" title="Image Title" width="Image Width" height="Image Height" data-attribute-x="xyz" />

Set favicon from image

Copy
{% set_favicon "favicon" %}
or
{% image img = "favicon" %}
{% set_favicon img %}