{{page}}

page Properties

Field Type Description
object_type string page
is_valid True|False Indicates whether or not this references a page.
guid guid The unique identifier for this page
site_domain_guid text_field  
ssl_mode text_field  
include_in_search true/false  
domain_name text_field  
url text_field  
entity_guid text_field  
entity entity  
entity_type_id number  
template_guid text_field  
ssl_mode text_field  
template template  
canonical_url url_field  
browser_title text_field  
meta_description textarea_field  
meta_robots textarea_field  
keywords textarea_field  
full_url string The full URL of the page - including the scheme ("http://", "https://" or just "//"), the domain name, and the path.
visited true/false Whether or not the user has visited the blog before 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).
custom varies Each blog includes all of the custom properties defined by the template.
value string Synonymn for guid
output html The default output that the blog produces when output directly to the template.
output_in_list html The default output that the blog produces when output directly to the template as part of a list.

pages Properties

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

Examples

Fetch Page by Guid

Copy
{% page var example = "d7d9db4d-2476-4ce6-b6dd-bd44f307903d" %}

{{example.title}}

Methods

{% page %}

Fetch a single page.

{% page[var|set|assign] new_variable_nameSpecify 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_templateIf included, the results will be output directly to the template. = page|guid|stringFetch the page by supplying a page object, guid, or string%}

You MUST include at least either a variable name to assign the page to, "output_to_template", or both (if both, output_to_template should be the later argument).

If you are assigning the page to a variable and do not specify one of "var", "set", or "assign", then the "var" behavior will be used - which is to save the result on the current scope.

If you are outputting the page to the template, it will use the default output for pages.

{% pages %}

{% pages
[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:page|pages|guid|string
 
Prepend the specified articles before the fetched results. All prepended input will be returned in the same order that it is input.
append:page|pages|guid|string
 
Append the specified articles after the fetched results. All appended input will be returned in the same order that it is input.
exclude:page|pages|guid|string
 
Prevent the specified articles from being included in the fetched results. Has no affect on prepended and appended articles
exclude_prepended:true
 
Specifically exclude all prepended articles 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 articles 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 articles. The "limit" may be automatically lowered to only fetch the maximum number of articles 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 articles that match the given string filter
has_url:boolean
 
Filter results to only return articles for which has_url exactly matches the specified value.
start_date:datetime
 
Filter results to return articles for which post_date is greater than or equal to start_date.
end_date:datetime
 
Filter results to return articles for which post_date is less than or equal to end_date.
template:template|templates|guid|string
 
Only return articles with one of these templates
include_in_search:boolean
 
Filter results to only return articles for which include_in_search exactly matches the specified value.
site_domain_guid:guid
 
Filter results to only return articles for which site_domain_guid exactly matches the specified value.
ssl_mode:string
 
Filter results to only return articles for which ssl_mode exactly matches the specified value.
tag:tag|tags|guid|string
 
Only return articles with one of these tags
author:author|authors|guid|string
 
Only return articles with one of these authors
folder:folder|folders|guid|string
 
Only return articles with one of these folders
date_created_start:datetime
 
Filter results to return articles for which date_created is greater than or equal to date_created_start.
date_created_end:datetime
 
Filter results to return articles for which date_created is less than or equal to date_created_end.
start:1
 
Set the 1-based index of the first article to fetch.
page:1
 
Automatically calculate the first article 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 articles 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 articles.
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:
  • PostDate
  • 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 (Using random sorting prevents fast caching of the page).
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")