Skip to documentation content

Calendar Entry

On this page

    The calendar entry object and its properties.

    {{ calendar_entry }}

    Properties
    Name Type Description
    object_type string Will always be calendar_entry
    is_valid boolean True if this references a published calendar_entry
    guid string The unique identifier for this calendar_entry
    value string Synonym for guid
    name {{ text }} The name of the calendar_entry
    title {{ text }} The title of the calendar_entry
    linked_title string A link to the calendar_entry if it has a URL, or the escaped title if not
    image_guid string The unique identifier of the related image
    image {{ image }} Reference to the related image object
    description {{ html }} Short descriptive text shown with this item
    calendar_guid string The unique identifier of the related calendar
    calendar {{ calendar }} Reference to the related calendar object
    parent_calendar_entry_guid string The unique identifier of the parent calendar entry. Not currently used
    calendar_entry {{ calendar_entry }} Reference to the related calendar entry object. Not currently used
    timezone {{ timezone }} The timezone specified for this calendar entry, which should the timezone used by both the start and end dates
    start_date {{ datetime }} The date and time that this event will start (or started, if it is in the past)
    all_day boolean If true, specifies that this event lasts all day (no specific start/end times). It may still be a single or multi-day event
    end_date {{ datetime }} The date and time that this event will end (or ended, if it is in the past)
    location {{ text }} Text describing the location of the event
    link {{ url }} URL containing additional information about this event, typically used to direct users to an external page or to a page with additional information related to this event
    tags {{ tags }} The list of tags associated with this calendar_entry
    authors {{ authors }} The list of authors associated with this calendar_entry
    has_url boolean True if the calendar_entry has a URL
    include_in_search boolean Whether or not this calendar_entry should be returned in on-site search results
    domain_name {{ text }} The domain name used by the URL for this calendar_entry
    url {{ text }} The portion of the URL for this calendar_entry following the domain name
    full_url string The full URL for this calendar_entry 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 calendar_entry does not have a URL)
    search_entity {{ entity }} The entity that search results should be directed to (if this calendar_entry does not have a URL)
    folder_guid string The unique identifier for the folder that contains this calendar_entry.
    folder {{ folder }} The folder that contains this calendar_entry.
    field_id string The identifier for this field
    label string The label for this field
    output string The default output that the calendar_entry 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 calendar entries themselves
    data {{ data }} Object containing the custom fields on this calendar_entry
    * string Specific custom fields may be accessed using {{ entity.fieldid }} or {{calendar_entry['field-id']}}
    Example Calendar Entry time and formattingFormat a calendar entry start/end time for display using the date filter and optional timezone.
    Liquid
    {%- if calendar_entry.start_date.date.is_future -%}
	Event will start on {{calendar_entry.start_date | date: 'g' -}}
{%- elsif calendar_entry.end_date.date.is_future -%}
	Event is currently in progress
{%- else -%}
	Event completed on {{calendar_entry.end_date | date: 'g' -}}
{%- endif -%}

    {{ calendar_entries }}

    Contains multiple calendar_entries.

    Properties
    Name Type Description
    object_type string Will always be calendar_entries
    is_valid boolean True if this contains at least one published calendar_entry
    output string The default output that the calendar_entries will produce when it is output directly to the template - using the "output_in_list" property of each calendar_entry in the items list
    prepended list List containing any prepended calendar_entries.
    fetched list List containing all of the calendar_entries that were fetched from the database (as opposed to prepended or appended).
    appended list List containing any appended calendar_entries.
    appended_unique list List containing any appended calendar_entries excluding any calendar_entries that are in either the list of prepended or fetched calendar_entries.
    items list List containing all of the combined calendar_entries 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 calendar_entries specified.
    size integer The total number of calendar_entries 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 calendar_entries 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_entry will be included.
    limit integer The maximum number of items that were allowed to be in the list of fetched calendar_entries. May be 0 in some cases (such as when when there are no fetched calendar_entries.
    start integer The 1-based index of the first item in the list of fetched calendar_entries.
    page integer The 1-based index of the paginated results returned in the list of fetched calendar_entries, 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 calendar_entries
    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 calendar_entries for the next month using assign and date filtersSet a date range (e.g. from now to one month ahead) and fetch calendar_entries into the template.
    Liquid
    {%- assign minDate = "now" | midnight -%}
{%- assign maxDate = minDate | add_months: 1 -%}
{%- calendar_entries output_to_template start_date:minDate end_date:maxDate limit:30 sort_by:"start_date" sort_direction:"asc" -%}
    Example Get Calendar Entries for the Next MonthSet a date range with midnight and add_months, then fetch the next 30 calendar_entries sorted by start_date.
    Liquid
    {%- var minDate = "now" | midnight -%}
{%- var maxDate = "now" | midnight | add_months: 1 -%}
{%- calendar_entries var entries = start_date:minDate end_date:maxDate limit:30 sort_by:"start_date" sort_direction:"asc" -%}

    Use simple date math to get the start and end dates to use for the calendar_entries method, then store the result in the entries variable.

    {% calendar_entry %}

    {% calendar_entry output_to_template? [[var, set, or assign]? variable]? output_to_template? = value %}
    Parameters
    output_to_template optionalflag
    If included the {% calendar_entry %} will be output directly to the template.
    var, set, or assign optionalkeyword
    Optional. Specify either "var", "set" or "assign" to change which scope this {% calendar_entry %} is stored on. "var" is the default behavior.
    variable_name optionalvariable
    Specify a variable name in order to save this calendar_entry to a variable. If not specified, it will be output to the template instead.
    value requiredexpression
    Should evaluate to an object of type calendar_entry, or the name or guid of one. May use liquid filters.

    Fetches a single {{ calendar_entry }}.

    {% calendar_entries %}

    {% calendar_entries output_to_template? [[var, set, or assign]? variable]? output_to_template? = arguments %}
    Parameters
    output_to_template optionalflag
    If included the {% calendar_entries %} will be output directly to the template.
    var, set, or assign optionalkeyword
    Optional. Specify either "var", "set" or "assign" to change which scope this {% calendar_entries %} 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 calendar_entry, a list of calendar_entries, or the name or guid of one calendar_entry, to be included at the beginning of the calendar_entries list.
    append optionallist
    May be a single calendar_entry, a list of calendar_entries, or the name or guid of one calendar_entry, to be included at the end of the calendar_entries list.
    exclude optionallist
    May be a single calendar_entry, a list of calendar_entries, or the name or guid of one calendar_entry that should NOT be included in the fetched results. Has no effect on prepended or appended calendar_entries.
    exclude_prepended optionalboolean
    True to specifically exclude all prepended calendar_entries 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 calendar_entries 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 calendar_entries as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting calendar_entries. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
    filter optionalvalue
    Only include calendar entries that match the given string filter
    calendar optionalvalue
    May include multiple calendars. Only include calendar entries with one of the given calendars
    start_date optionalvalue
    Only include calendar entries starting on or after start_date
    end_date optionalvalue
    Only include calendar entries ending on or before end_date
    tag optionalvalue
    May include multiple tags. Only include calendar entries with one of the given tags
    author optionalvalue
    May include multiple authors. Only include calendar entries with one of the given authors
    folder optionalvalue
    May include multiple folders. Only include calendar entries with one of the given folders
    date_created_start optionalvalue
    Only include calendar entries with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the calendar entry was first published.
    date_created_end optionalvalue
    Only include calendar entries with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the calendar entry was first published.
    has_url optionalboolean
    If true, only return calendar_entries that have a URL. If false, only return calendar_entries that do NOT have a URL.
    template optionalobject
    Only return calendar_entries 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 calendar_entries whose include_in_search property matches the provided value.
    domain_name optionalobject
    Only return calendar_entries from the given domain.
    start optionalinteger
    Set the 1-based index of the first calendar_entry to fetch.
    page optionalinteger
    Used to automatically calculate the first calendar_entry 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 calendar_entries 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 calendar_entries. 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. When sorting by relevance sort_direction is ignored.
    • date_created: the date each calendar_entry 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 {{ calendar_entries }}.

    Example Fetch calendar_entries for the next month using assign and date filtersSet a date range (e.g. from now to one month ahead) and fetch calendar_entries into the template.
    Liquid
    {%- assign minDate = "now" | midnight -%}
{%- assign maxDate = minDate | add_months: 1 -%}
{%- calendar_entries output_to_template start_date:minDate end_date:maxDate limit:30 sort_by:"start_date" sort_direction:"asc" -%}
    Example Get Calendar Entries for the Next MonthSet a date range with midnight and add_months, then fetch the next 30 calendar_entries sorted by start_date.
    Liquid
    {%- var minDate = "now" | midnight -%}
{%- var maxDate = "now" | midnight | add_months: 1 -%}
{%- calendar_entries var entries = start_date:minDate end_date:maxDate limit:30 sort_by:"start_date" sort_direction:"asc" -%}

    Use simple date math to get the start and end dates to use for the calendar_entries method, then store the result in the entries variable.