Error Page

Error Page

{{ error_page }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published error_page
guid String The unique identifier for this error_page
value String Synonymn for guid
name text The name of the error_page
title text The title of the error_page
linked_title String A link to the error_page if it has a URL, or the escaped title if not
error_code select HTTP status code handled by this error page (e.g., 404, 500)
url_filter text The URL filter used to limit which URLs this error page may be shown for (ie: to display different error pages for different sections of the site)
content_html html The primary HTML content for the error page
has_url Boolean True if the error_page has a URL
include_in_search Boolean Whether or not this error_page should be returned in on-site search results
domain_name text The domain name used by the URL for this error_page
url text The portion of the URL for this error_page following the domain name
full_url String The full URL for this error_page 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 error_page does not have a URL)
search_entity entity The entity that search results should be directed to (if this error_page does not have a URL)
folder_guid String The unique identifier for the folder that contains this error_page.
folder folder The folder that contains this error_page.
field_id String The identifier for this field
label String The label for this field
output String The default output that the error_page 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 error pages themselves
data data Object containing the custom fields on this error_page
* String Specific custom fields may be accessed using {{ entity.fieldid }} or {{error_page['field-id']}}

{{ error_pages }}

Contains multiple error_pages.

Name Type Description
output String The default output that the error_pages will produce when it is output directly to the template - using the "output_in_list" property of each error_page in the items list

{% error_page %}

{% error_page
var|set|assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this error_page is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this error_page to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the error_page will be output directly to the template.
=
%}

{% error_pages %}

{% error_pages
var|set|assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this error_pages is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this error_pages to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the error_pages will be output directly to the template.
=
prepend:value
 
Prepend the specified error_pages before the fetched results. All prepended input will be returned in the same order that it is input. Value may one or more error_pages, a guid, or a string.
append:value
 
Append the specified error_pages after the fetched results. All appended input will be returned in the same order that it is input. Value may one or more error_pages, a guid, or a string.
exclude:value
 
Prevent the specified error_pages from being included in the fetched results. Has no affect on prepended and appended items. Value may one or more error_pages, a guid, or a string.
exclude_prepended:true
 
Specifically exclude all prepended error_pages 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 error_pages 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:number
 
If specified, then the "items" list will only include up to the specified number of error_pages. 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".
%}