Snippet

Snippet

{{ snippet }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published snippet
guid String The unique identifier for this snippet
value String Contains the same value as guid
name text The unique name of the snippet. This property is primarily intended for internal use by website administrators to uniquely identify snippets
folder_guid String The unique identifier of the related folder
folder folder Reference to the related folder object
content_html html The HTML content for the snippet
tags tags The list of tags associated with this snippet
search_entity_guid String The unique identifier for the entity that search results should be directed to
search_entity entity The entity that search results should be directed to
field_id String The identifier for this field
label String The label for this field
output String Identical to using {{ snippet.content_html.value }}

{{ snippets }}

Contains multiple snippets.

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this contains at least one published snippet
output String The default output that the snippets will produce when it is output directly to the template - using the "output_in_list" property of each snippet in the items list
prepended list List containing any prepended snippets.
fetched list List containing all of the snippets that were fetched from the database (as opposed to prepended or appended).
appended list List containing any appended snippets.
appended_unique list List containing any appended snippets excluding any snippets that are in either the list of prepended or fetched snippets.
items list List containing all of the combined snippets 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 snippets specified.
size Integer The total number of snippets 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 snippets 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 snippet will be included.
limit Integer The maximum number of items that were allowed to be in the list of fetched snippets. May be 0 in some cases (such as when when there are no fetched snippets.
start Integer The 1-based index of the first item in the list of fetched snippets.
page Integer The 1-based index of the paginated results returned in the list of fetched snippets, 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 snippets
total_pages Integer

{% snippet %}

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

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

{% snippets %}

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

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

arguments

prepend
 
May be a single snippet, a list of snippets, or the name or guid of a snippet to be be included at the beginning of the snippets.
append
 
May be a single snippet, a list of snippets, or the name or guid of a snippet to be be included at the end of the snippets.
exclude
 
May be a single snippet, a list of snippets, or the name or guid of a snippet that should NOT be included in the fetched results. Has no affect on prepended or appended snippets.
exclude_prepended
 
True to specifically exclude all prepended snippets 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 snippets 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 snippets as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting snippets. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
tag
 
May include multiple tags. Only include snippets with one of the given tags
folder
 
May include multiple folders. Only include snippets with one of the given folders
date_created_start
 
Only include snippets with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the snippet was first published.
date_created_end
 
Only include snippets with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the snippet was first published.
start
 
Set the 1-based index of the first snippet to fetch.
page
 
Used to automatically calculate the first snippet 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 snippets 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 snippets. Options include:
  • date_created: the date each snippets was first published. Unpublishing and republishing a snippets 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 snippets.