{{ entities }}

entities Properties

Contains a collection of content, including pagination-related information.

Field Type Description
object_type string Will always be "entities".
is_valid true/false Returns true if this contains at least one entity.
prepended list of entities entities that will be listed at the beginning of the items list
fetched list of entities The primary list of entities to be included in the items list
appended list of entities entities that will be listed at the end of the items list
appended_unique list of entities pages that will be listed at the end of the items list, excluding any pages that are already included in either the prepended or fetched lists
items list of entities The full list of entities in the proper order and uniqueness, including prepended, fetched, and appended entities
size number The total number of items in the list of items, including prepended, fetched, and appended entities
limit number The maximum number of entities that could have been fetched dynamically from the database
start number The 1-based index of the first entity that was (or would have been) dynamically fetched from the database
page number The 1-based index of the first "page" of entities that could have been fetched dynamically from the database - as determined by the start and limit properties
total_count number The total number of entities in the database that matched the provided filter parameters when fetching the list of fetched entities
total_pages number The total number of "pages" of results that matched the provided filter parameters when fetching the list of fetched entities - as determined by the total_count and limit properties
output html The default output that the entities will produce when it is output directly to the template - using the "output_in_list" property of each entity in the items list

Methods

{% entities %}

Fetch a list of entities.

{% entities
[var|set|assign] new_variable_name
 
Specify a variable name in order to save the results to a variable. If not specified the results will be output to the template instead. The variable will be saved using the "var" behavior unless "set" or "assign" are specified.
output_to_template
 
If included, the results will be output directly to the template.
=
prepend:entity|content|guid
 
Prepend the specified content before the fetched results. All prepended input will be returned in the same order that it is input.
append:entity|content|guid
 
Append the specified content after the fetched results. All appended input will be returned in the same order that it is input.
exclude:entity|content|guid
 
Prevent the specified content from being included in the fetched results. Has no affect on prepended and appended content
exclude_prepended:true
 
Specifically exclude all prepended content 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
 
Specifically exclude all appended content 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
 
If set to true, each of the resulting lists (prepended, fetched, appended, and items) will be unique, 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:25
 
If specified, then the "items" list will only include up to the specified number of content. The "limit" may be automatically lowered to only fetch the maximum number of content that will be included in "items" following prepended items. Note that this may also impact both the "page and "total_pages" values. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
filter:string
 
Only return content that match the given string filter
has_url:boolean
 
Filter results to only return content for which has_url exactly matches the specified value.
global_type_id:string
 
Filter results to return content of that match the specified value.
template:template|templates|guid|string
 
Only return content with one of these templates
include_in_search:boolean
 
Filter results to only return content for which include_in_search exactly matches the specified value.
site_domain_guid:guid
 
Filter results to only return content for which site_domain_guid exactly matches the specified value.
ssl_mode:string
 
Filter results to only return content for which ssl_mode exactly matches the specified value.
tag:tag|tags|guid|string
 
Only return content with one of these tags
author:author|authors|guid|string
 
Only return content with one of these authors
folder:folder|folders|guid|string
 
Only return content with one of these folders
date_created_start:datetime
 
Filter results to return content for which date_created is greater than or equal to date_created_start.
date_created_end:datetime
 
Filter results to return content for which date_created is less than or equal to date_created_end.
start:1
 
Set the 1-based index of the first entity to fetch.
page:1
 
Automatically calculate the first entity to fetch based on both of the "limit" and the 1-based "page" value. Ignored if "start" is set.
limit:25
 
Defines the maximum number of content to be fetched. If not included, this will default to 10. Note that if "max_size" is specified then "limit" may be automatically lowered even if specified.
sort_by:"date_created"
 
Specify which field to sort the fetched results by. Has no affect on prepended or appended content.
By default results will be sorted by relevance if there is a filter string and date_created (the date the item was first published) desc (newest first) if not.
Other Options include:
  • Name
  • Title
  • URL
  • BrowserTitle
  • relevance (based on which field matches the given filter and where in the field the match is found. When sorting by relevance sort_direction is irrelevant)
  • date_created (Equivalent to the date you first published this item. Unpublishing and republishing the item resets date_created to the current date)
  • random (By default using random sorting prevents fast caching of the page. Setting "cache_random:true" overrides this behavior and allows the page to be fast-cached anyway)
sort_direction:"desc"
 
Specify whether the fetched results should be sorted in asc (ascending) or desc (descending) order.
%}

If you do not include any filters or inputs other than prepended items, appended items, or max_size, then no additional items will be fetched. If you wish to fetch all items you must include at least one additional input (ie: "start:1")