Folder

Folder

Folders are a means of grouping like objects together within CMS. These can be used for specific types of objects only, such as with images, or can be used across multiple object types. For example, grouping images and articles for "Company A" into one folder and other images and articles for "Company B" into a separate folder.

{{ folder }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published folder
guid String The unique identifier for this folder
value String Synonymn for guid
name text The name of the folder
title text The title of the folder
linked_title String A link to the folder if it has a URL, or the escaped title if not
sub_folders folders A list containing all of the child folders of the current folder
has_url Boolean True if the folder has a URL
include_in_search Boolean Whether or not this folder should be returned in on-site search results
domain_name text The domain name used by the URL for this folder
url text The portion of the URL for this folder following the domain name
full_url String The full URL for this folder 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 folder does not have a URL)
search_entity entity The entity that search results should be directed to (if this folder does not have a URL)
folder_guid String The unique identifier for the folder that contains this folder.
folder folder The folder that contains this folder.
field_id String The identifier for this field
label String The label for this field
output String The default output that the folder 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 folders themselves
data data Object containing the custom fields on this folder
* String Specific custom fields may be accessed using {{ entity.fieldid }} or {{folder['field-id']}}

{{ folders }}

Contains multiple folders.

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

{% folder %}

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

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

{% folders %}

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

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

arguments

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