Skip to documentation content

Calendar

On this page

    The calendar object and methods for calendars.

    {{ calendar }}

    Properties
    Name Type Description
    object_type string Will always be calendar
    is_valid boolean True if this references a published calendar
    guid string The unique identifier for this calendar
    value string Synonym for guid
    name {{ text }} The name of the calendar
    title {{ text }} The title of the calendar
    linked_title string A link to the calendar if it has a URL, or the escaped title if not
    timezone {{ timezone }} The default timezone for events in this calendar
    has_url boolean True if the calendar has a URL
    include_in_search boolean Whether or not this calendar should be returned in on-site search results
    domain_name {{ text }} The domain name used by the URL for this calendar
    url {{ text }} The portion of the URL for this calendar following the domain name
    full_url string The full URL for this calendar 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 for this URL. The editor requires a browser title for every entity that has a 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 calendar does not have a URL)
    search_entity {{ entity }} The entity that search results should be directed to (if this calendar does not have a URL)
    folder_guid string The unique identifier for the folder that contains this calendar.
    folder {{ folder }} The folder that contains this calendar.
    field_id string The identifier for this field
    label string The label for this field
    output string The default output that the calendar 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 calendars themselves
    data {{ data }} Object containing the custom fields on this calendar
    * string Specific custom fields may be accessed using {{ entity.fieldid }} or {{calendar['field-id']}}
    Example Load one calendar and show its title and timezone{% calendar %} loads a single calendar by name or GUID; timezone is the calendar-specific field alongside shared entity properties.
    Liquid
    {%- calendar var events = "Company Events" -%}
{%- if events.is_valid -%}
	<h2>{{ events.title }}</h2>
	<p>Timezone: {{ events.timezone }}</p>
{%- endif -%}

    {% calendar %} fetches a single calendar. Pass a name or GUID after the assignment target. The calendar-specific timezone field sits alongside shared entity properties such as title and is_valid. Entries on the calendar are loaded with {% calendar_entries %} or {% calendar_entry %}.

    Example Fetch calendars by filter string and list their titles{% calendars %} returns a calendars list; use filter (and shared list options) to narrow results.
    Liquid
    {%- calendars var feeds = filter:"Events" limit:25 sort_by:"title" -%}
<ul>
{%- for feed in feeds -%}
	<li>{{ feed.linked_title }} ({{ feed.timezone }})</li>
{%- endfor -%}
</ul>

    {% calendars %} is the list method for calendar entities. Type-specific options such as filter and folder combine with shared list options (limit, sort_by). Iterate the resulting calendars object directly.

    {{ calendars }}

    Contains multiple calendars.

    Properties
    Name Type Description
    object_type string Will always be calendars
    is_valid boolean True if this contains at least one published calendar
    output string The default output that the calendars will produce when it is output directly to the template - using the "output_in_list" property of each calendar in the items list
    prepended list List containing any prepended calendars.
    fetched list List containing all of the calendars that were fetched from the database (as opposed to prepended or appended).
    appended list List containing any appended calendars.
    appended_unique list List containing any appended calendars excluding any calendars that are in either the list of prepended or fetched calendars.
    items list List containing all of the combined calendars 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 calendars specified.
    size integer The total number of calendars 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 calendars 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 calendar will be included.
    limit integer The maximum number of items that were allowed to be in the list of fetched calendars. May be 0 in some cases (such as when when there are no fetched calendars.
    start integer The 1-based index of the first item in the list of fetched calendars.
    page integer The 1-based index of the paginated results returned in the list of fetched calendars, 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 calendars
    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.
    Example Fetch calendars by filter string and list their titles{% calendars %} returns a calendars list; use filter (and shared list options) to narrow results.
    Liquid
    {%- calendars var feeds = filter:"Events" limit:25 sort_by:"title" -%}
<ul>
{%- for feed in feeds -%}
	<li>{{ feed.linked_title }} ({{ feed.timezone }})</li>
{%- endfor -%}
</ul>

    {% calendars %} is the list method for calendar entities. Type-specific options such as filter and folder combine with shared list options (limit, sort_by). Iterate the resulting calendars object directly.

    {% calendar %}

    {% calendar output_to_template? [[var, set, or assign]? variable_name]? output_to_template? = value %}
    Parameters
    output_to_template optionalflag
    Include this flag to write the calendar's output into the page at this point. What that output is differs by type, and for most types it is a built-in default that may change at any time, so see the output property of the calendar object before relying on it. The flag may come before or after the variable name. When the call names no variable, the output is written whether or not the flag is present, which makes {% calendar = value %} the smallest valid use of this method. When the call names a variable, the flag saves the calendar to the variable and writes its output as well.
    var, set, or assign optionalkeyword
    Chooses the scope that holds the variable. var, the default, stores it in the current scope. set and assign can store it in outer scopes; Variable Scopes compares the three and when each fits.
    variable_name optionalvariable
    The variable that receives the calendar. It may also be written as a reference, &name, which reads the variable's name from another variable (see Methods Overview). Leave it out to write the calendar to the template instead.
    value requiredexpression
    Required; without a value the method call is not valid. Identifies which calendar to fetch. It can evaluate to the calendar itself, to its GUID, or to other text that identifies it, which for most types is its name; a type identified some other way, or only by GUID, says so in its summary. Names are matched without regard to case, but accented letters must match. A GUID identifies exactly one record, whereas when several records share a name, which of them is returned is not specified, so giving the records you fetch by name unique names avoids the question. A name reads better in a template and a GUID is exact; neither suits every site. When nothing matches, no error is raised: the variable holds an invalid calendar, whose is_valid is false, so check is_valid before using it. When the expression itself has no value, for example an undefined variable, the method does nothing and the variable keeps any earlier value. May use liquid filters.

    Fetches a single {{ calendar }}.

    Example Load one calendar and show its title and timezone{% calendar %} loads a single calendar by name or GUID; timezone is the calendar-specific field alongside shared entity properties.
    Liquid
    {%- calendar var events = "Company Events" -%}
{%- if events.is_valid -%}
	<h2>{{ events.title }}</h2>
	<p>Timezone: {{ events.timezone }}</p>
{%- endif -%}

    {% calendar %} fetches a single calendar. Pass a name or GUID after the assignment target. The calendar-specific timezone field sits alongside shared entity properties such as title and is_valid. Entries on the calendar are loaded with {% calendar_entries %} or {% calendar_entry %}.

    {% calendars %}

    {% calendars output_to_template? [[var, set, or assign]? variable_name]? output_to_template? = arguments %}
    Parameters
    output_to_template optionalflag
    Include this flag to write the calendars list's output into the page here. That output is a built-in default for most types and may change at any time, so see the output property of the calendars object before relying on it. The flag may come before or after the variable name. With no variable named, the output is written whether or not the flag is present; with one, the flag saves the list and writes its output too.
    var, set, or assign optionalkeyword
    Chooses the scope that holds the variable. var, the default, stores it in the current scope. set and assign can store it in outer scopes; Variable Scopes compares the three and when each fits.
    variable_name optionalvariable
    The variable that receives the calendars list. It may also be written as a reference, &name, which reads the variable's name from another variable (see Methods Overview). Leave it out to write the list to the template instead.
    arguments requiredcollection
    Key:value pairs. May use the variable arguments syntax. Written after a required =. The name:value pairs choose which calendars to fetch and how to narrow, order and page them. Nothing is fetched unless the call gives an argument other than prepend, append, unique, exclude_prepended, exclude_appended, max_size and cache_random; without one, the list holds only the prepended and appended calendars.

    Options

    prepend optionallist
    May be a single calendar, a list of calendars, or the name or guid of one calendar, to be included at the beginning of the calendars list.
    append optionallist
    May be a single calendar, a list of calendars, or the name or guid of one calendar, to be included at the end of the calendars list.
    exclude optionallist
    May be a single calendar, a list of calendars, or the name or guid of one calendar that should NOT be included in the fetched results. Has no effect on prepended or appended calendars.
    exclude_prepended optionalboolean
    True to specifically exclude all prepended calendars 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 calendars 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 calendars as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting calendars. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
    filter optionalvalue
    Only include calendars that match the given string filter
    folder optionalvalue
    May include multiple folders. Only include calendars with one of the given folders
    date_created_start optionalvalue
    Only include calendars with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the calendar was first published.
    date_created_end optionalvalue
    Only include calendars with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the calendar was first published.
    has_url optionalboolean
    If true, only return calendars that have a URL. If false, only return calendars that do NOT have a URL.
    template optionalobject
    Only return calendars 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. A template name is its path from the root, with or without the leading /; unlike {% template %}, a list method does not accept a relative path.
    include_in_search optionalboolean
    True or false to only return calendars whose include_in_search property matches the provided value.
    domain_name optionalobject
    Only return calendars from the given domain.
    start optionalinteger
    Set the 1-based index of the first calendar to fetch.
    page optionalinteger
    Used to automatically calculate the first calendar 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 calendars to fetch. Defaults to 10; a value that is not a number also gives 10. The largest limit is 1000, and a limit of 0 or less, or above 1000, returns up to 1000 calendars. 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 calendars. An unrecognized value is ignored without an error and the default order is used. Some methods accept more values than the built-ins listed here; see each method. By default, results will be sorted by relevance if there is a filter string and date_created desc (newest first) if not. Options include:
    • relevance: only applies when there is a filter string. sort_direction applies: descending, the default, puts the best match first.
    • date_created: the date each calendar 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. Defaults to desc; any value other than asc sorts descending.
    cache_random optionalboolean
    True to allow the results to be cached when sort_by is "random".

    Fetches a list of {{ calendars }}.

    Example Fetch calendars by filter string and list their titles{% calendars %} returns a calendars list; use filter (and shared list options) to narrow results.
    Liquid
    {%- calendars var feeds = filter:"Events" limit:25 sort_by:"title" -%}
<ul>
{%- for feed in feeds -%}
	<li>{{ feed.linked_title }} ({{ feed.timezone }})</li>
{%- endfor -%}
</ul>

    {% calendars %} is the list method for calendar entities. Type-specific options such as filter and folder combine with shared list options (limit, sort_by). Iterate the resulting calendars object directly.