{{ entity }}

entity Properties

Field containing a URL.

Field Type Description
object_type string The object_type of this entity (eg: "article", "tag", or "blog_post").
is_valid True|False Indicates whether or not this references an entity.
guid guid The unique identifier for this entity.
name text_field The entity name. This field is primarily intended for internal use by website administrators to identify objects.
title text_field The entity title.
linked_title html A link to the default page if one exists, or the escaped title if not.
default_page_guid text_field The unique identifier of the default page, if one exists.
default_page_url text_field The URL of the default page, if one exists.
page page The default page, if one exists.
Type-Specific Properties   Each entity will include the specific property of the entity type that it belongs to (eg: if it is a blog_post it will include the blog, image, post_date, etc... properties).
value string Synonymn for guid.
output html The default output that the entity would produce if it were output directly to the template.
output_in_list html The default output that the article would produce if it were output directly to to the template from inside a list.

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