Skip to documentation content

Error Page

On this page

    The error_page object and its use for error pages.

    {{ error_page }}

    Properties
    Name Type Description
    object_type string Will always be error_page
    is_valid boolean True if this references a published error_page
    guid string The unique identifier for this error_page
    value string Synonym 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.

    Properties
    Name Type Description
    object_type string Will always be error_pages
    is_valid boolean True if this contains at least one published error_page
    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
    prepended list List containing any prepended error_pages.
    fetched list List containing all of the error_pages that were fetched from the database (as opposed to prepended or appended).
    appended list List containing any appended error_pages.
    appended_unique list List containing any appended error_pages excluding any error_pages that are in either the list of prepended or fetched error_pages.
    items list List containing all of the combined error_pages 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 error_pages specified.
    size integer The total number of error_pages 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 error_pages 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 error_page will be included.
    limit integer The maximum number of items that were allowed to be in the list of fetched error_pages. May be 0 in some cases (such as when when there are no fetched error_pages.
    start integer The 1-based index of the first item in the list of fetched error_pages.
    page integer The 1-based index of the paginated results returned in the list of fetched error_pages, 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 error_pages
    total_pages integer If any items were fetched from the database, total_pages will contain the number of paginated result pages in the database for the provided arguments. This may also be calculated using the total_count and limit properties.

    {% error_page %}

    {% error_page output_to_template? [[var, set, or assign]? variable]? output_to_template? = value %}
    Parameters
    output_to_template optionalflag
    If included the {% error_page %} will be output directly to the template.
    var, set, or assign optionalkeyword
    Optional. Specify either "var", "set" or "assign" to change which scope this {% error_page %} is stored on. "var" is the default behavior.
    variable_name optionalvariable
    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.
    value requiredexpression
    Should evaluate to an object of type error_page, or the name or guid of one. May use liquid filters.

    Fetches a single {{ error_page }}.

    {% error_pages %}

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

    Options

    prepend optionallist
    May be a single error_page, a list of error_pages, or the name or guid of one error_page, to be included at the beginning of the error_pages list.
    append optionallist
    May be a single error_page, a list of error_pages, or the name or guid of one error_page, to be included at the end of the error_pages list.
    exclude optionallist
    May be a single error_page, a list of error_pages, or the name or guid of one error_page that should NOT be included in the fetched results. Has no effect on prepended or appended error_pages.
    exclude_prepended optionalboolean
    True to 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 optionalboolean
    True to 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 optionalboolean
    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 optionalinteger
    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 error_pages as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting error_pages. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
    folder optionalvalue
    May include multiple folders. Only include error pages with one of the given folders
    date_created_start optionalvalue
    Only include error pages with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the error page was first published.
    date_created_end optionalvalue
    Only include error pages with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the error page was first published.
    has_url optionalboolean
    If true, only return error_pages that have a URL. If false, only return error_pages that do NOT have a URL.
    template optionalobject
    Only return error_pages with one of these templates. May be a single template, a list of templates, or the name or guid of a template to filter the results by.
    include_in_search optionalboolean
    True or false to only return error_pages whose include_in_search property matches the provided value.
    domain_name optionalobject
    Only return error_pages from the given domain.
    start optionalinteger
    Set the 1-based index of the first error_page to fetch.
    page optionalinteger
    Used to automatically calculate the first error_page to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.
    limit optionalinteger
    The maximum number of error_pages to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
    sort_by optionalstring
    Specify which property to sort the results by. Has no effect on prepended or appended error_pages. Options include:
    • date_created: the date each error_page was first published. Unpublishing and republishing one 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 optionalstring
    asc or desc.
    cache_random optionalboolean
    True to allow the results to be cached when sort_by is "random".

    Fetches a list of {{ error_pages }}.