Skip to documentation content

Snippet

On this page

    The snippet object and methods for reusable snippet content.

    {{ snippet }}

    Properties
    Name Type Description
    object_type string Will always be snippet
    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 }}
    Example Load one snippet and output its content_html{% snippet %} loads a single snippet by name or GUID; content_html is the reusable markup body.
    Liquid
    {%- snippet var cta = "Primary CTA" -%}
{%- if cta.is_valid -%}
	<section class="cta">{{ cta.content_html }}</section>
{%- endif -%}

    {% snippet %} fetches a single snippet. Pass a name or GUID after the assignment target. Snippet fields include content_html (the reusable body), tags, folder, and name. Prefer this when you need the snippet's fields in Liquid; {% include %} is the usual way to render a partial template file instead.

    Example Fetch snippets from a folder and list their names{% snippets %} returns a snippets list; filter with folder or tag, then read each snippet's name and content_html.
    Liquid
    {%- snippets var blocks = folder:"CTAs" limit:25 sort_by:"name" -%}
<ul>
{%- for block in blocks -%}
	<li>{{ block.name }}</li>
{%- endfor -%}
</ul>

    {% snippets %} is the list method for snippet entities. Type-specific options such as folder and tag combine with shared list options (limit, sort_by). Iterate the resulting snippets object directly.

    {{ snippets }}

    Contains multiple snippets.

    Properties
    Name Type Description
    object_type string Will always be snippets
    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 If any items were fetched from the database, total_pages will contain the number of paginated result pages in the database for the provided arguments. This may also be calculated using the total_count and limit properties.
    Example Fetch snippets from a folder and list their names{% snippets %} returns a snippets list; filter with folder or tag, then read each snippet's name and content_html.
    Liquid
    {%- snippets var blocks = folder:"CTAs" limit:25 sort_by:"name" -%}
<ul>
{%- for block in blocks -%}
	<li>{{ block.name }}</li>
{%- endfor -%}
</ul>

    {% snippets %} is the list method for snippet entities. Type-specific options such as folder and tag combine with shared list options (limit, sort_by). Iterate the resulting snippets object directly.

    {% snippet %}

    {% snippet output_to_template? [[var, set, or assign]? variable_name]? output_to_template? = value %}
    Parameters
    output_to_template optionalflag
    Include this flag to write the snippet's output into the page at this point. What that output is differs by type, and for most types it is a built-in default that may change at any time, so see the output property of the snippet object before relying on it. The flag may come before or after the variable name. When the call names no variable, the output is written whether or not the flag is present, which makes {% snippet = value %} the smallest valid use of this method. When the call names a variable, the flag saves the snippet to the variable and writes its output as well.
    var, set, or assign optionalkeyword
    Chooses the scope that holds the variable. var, the default, stores it in the current scope. set and assign can store it in outer scopes; Variable Scopes compares the three and when each fits.
    variable_name optionalvariable
    The variable that receives the snippet. It may also be written as a reference, &name, which reads the variable's name from another variable (see Methods Overview). Leave it out to write the snippet to the template instead.
    value requiredexpression
    Required; without a value the method call is not valid. Identifies which snippet to fetch. It can evaluate to the snippet itself, to its GUID, or to other text that identifies it, which for most types is its name; a type identified some other way, or only by GUID, says so in its summary. Names are matched without regard to case, but accented letters must match. A GUID identifies exactly one record, whereas when several records share a name, which of them is returned is not specified, so giving the records you fetch by name unique names avoids the question. A name reads better in a template and a GUID is exact; neither suits every site. When nothing matches, no error is raised: the variable holds an invalid snippet, whose is_valid is false, so check is_valid before using it. When the expression itself has no value, for example an undefined variable, the method does nothing and the variable keeps any earlier value. May use liquid filters.

    Fetches a single {{ snippet }}.

    Example Load one snippet and output its content_html{% snippet %} loads a single snippet by name or GUID; content_html is the reusable markup body.
    Liquid
    {%- snippet var cta = "Primary CTA" -%}
{%- if cta.is_valid -%}
	<section class="cta">{{ cta.content_html }}</section>
{%- endif -%}

    {% snippet %} fetches a single snippet. Pass a name or GUID after the assignment target. Snippet fields include content_html (the reusable body), tags, folder, and name. Prefer this when you need the snippet's fields in Liquid; {% include %} is the usual way to render a partial template file instead.

    {% snippets %}

    {% snippets output_to_template? [[var, set, or assign]? variable_name]? output_to_template? = arguments %}
    Parameters
    output_to_template optionalflag
    Include this flag to write the snippets list's output into the page here. That output is a built-in default for most types and may change at any time, so see the output property of the snippets object before relying on it. The flag may come before or after the variable name. With no variable named, the output is written whether or not the flag is present; with one, the flag saves the list and writes its output too.
    var, set, or assign optionalkeyword
    Chooses the scope that holds the variable. var, the default, stores it in the current scope. set and assign can store it in outer scopes; Variable Scopes compares the three and when each fits.
    variable_name optionalvariable
    The variable that receives the snippets list. It may also be written as a reference, &name, which reads the variable's name from another variable (see Methods Overview). Leave it out to write the list to the template instead.
    arguments requiredcollection
    Key:value pairs. May use the variable arguments syntax. Written after a required =. The name:value pairs choose which snippets to fetch and how to narrow, order and page them. Nothing is fetched unless the call gives an argument other than prepend, append, unique, exclude_prepended, exclude_appended, max_size and cache_random; without one, the list holds only the prepended and appended snippets.

    Options

    prepend optionallist
    May be a single snippet, a list of snippets, or the name or guid of one snippet, to be included at the beginning of the snippets list.
    append optionallist
    May be a single snippet, a list of snippets, or the name or guid of one snippet, to be included at the end of the snippets list.
    exclude optionallist
    May be a single snippet, a list of snippets, or the name or guid of one snippet that should NOT be included in the fetched results. Has no effect on prepended or appended snippets.
    exclude_prepended optionalboolean
    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 optionalboolean
    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 optionalboolean
    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 optionalinteger
    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 optionalvalue
    May include multiple tags. Only include snippets with one of the given tags
    folder optionalvalue
    May include multiple folders. Only include snippets with one of the given folders
    date_created_start optionalvalue
    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 optionalvalue
    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 optionalinteger
    Set the 1-based index of the first snippet to fetch.
    page optionalinteger
    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 optionalinteger
    The maximum number of snippets to fetch. Defaults to 10; a value that is not a number also gives 10. The largest limit is 1000, and a limit of 0 or less, or above 1000, returns up to 1000 snippets. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
    sort_by optionalstring
    Specify which property to sort the results by. Has no effect on prepended or appended snippets. An unrecognized value is ignored without an error and the default order is used. Some methods accept more values than the built-ins listed here; see each method. Options include:
    • date_created: the date each snippet was first published. Unpublishing and republishing one 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 optionalstring
    asc or desc. Defaults to desc; any value other than asc sorts descending.
    cache_random optionalboolean
    True to allow the results to be cached when sort_by is "random".

    Fetches a list of {{ snippets }}.

    Example Fetch snippets from a folder and list their names{% snippets %} returns a snippets list; filter with folder or tag, then read each snippet's name and content_html.
    Liquid
    {%- snippets var blocks = folder:"CTAs" limit:25 sort_by:"name" -%}
<ul>
{%- for block in blocks -%}
	<li>{{ block.name }}</li>
{%- endfor -%}
</ul>

    {% snippets %} is the list method for snippet entities. Type-specific options such as folder and tag combine with shared list options (limit, sort_by). Iterate the resulting snippets object directly.