Template Tag Index

All template tags support two attributes: before=”value” and after=”value”. The values of the attributes will be placed before and after the output value. These attribute values must be wrapped in double quotes.

Date/Time template tags support the “format” attribute: format=”M, Y”, where the value is a PHP formatted date string. Only dtstart and dtend include the full date/time information for formatting.

Example: {title before="<h3>" after="</h3>"}

Event Template Tags

{title}
Displays the title of the event.
{link_title}
Displays title of the event as a link if a URL is present, or the title alone if no URL is available.
{link_image}
Displays featured image of the event as a link if a URL is present, or the image alone if no URL is available.
{time}
Displays the start time for the event.
{runtime}
Human language estimate of how long an event will run.
{date}
Displays the date on which the event begins.
{began}
Displays the date on which the series of events began (for recurring events).
{enddate}
Displays the date on which the event ends.
{endtime}
Displays the time at which the event ends.
{daterange}
Displays the beginning date to the end date for events. Does not show end date if same as start date.
{timerange}
Displays the beginning and end times for events. Does not show end time if same as start or if marked as hidden.
{dtstart}
Timestamp for beginning of event.
{dtend}
Timestamp for end of event.
{multidate}
For multi-day events displays an unordered list of dates and times for events in this group. Otherwise, beginning date/time.
{related}
List of other events in the same event group. (Only on single event views.)
{author}
Displays the WordPress author who posted the event.
{gravatar}
Displays the gravatar image for the event author.
{host}
Displays the name of the person assigned as host for the event.
{host_email}
Displays the email address of the person assigned as host for the event.
{host_gravatar}
Displays the gravatar image for the event host.
{shortdesc}
Displays the short version of the event description.
{shortdesc_raw}
Displays short description without converting paragraphs.
{shortdesc_stripped}
Displays short description with any HTML stripped out.
{excerpt}
Like the_excerpt(); displays shortdesc if provided, otherwise excerpts description.
{description}
Displays the description of the event.
{description_raw}
Displays description without converting paragraphs.
{description_stripped}
Displays description with any HTML stripped out.
{access}
Unordered list of accessibility options for this event.
{image}
Image associated with the event. (HTMl)
{image_url}
Image associated with the event. (image URL only)
{full}
Event post thumbnail, full size, full HTML
{thumbnail} / {thumbnail_url}
Event post thumbnail, thumbnail size, full HTML / image URL only
{medium} / {medium_url}
Event post thumbnail, medium size, full HTML / image URL only
{medium_large} / {medium_large_url}
Event post thumbnail, medium_large size, full HTML / image URL only
{large} / {large_url}
Event post thumbnail, large size, full HTML / image URL only
{link}
Displays the URL provided for the event.
{ical}
Produces the URL to download an iCal formatted record for the event.
{ical_html}
Produces a hyperlink to download an iCal formatted record for the event.
{gcal}
URL to submit event to Google Calendar
{gcal_link}
Link to submit event to Google Calendar, with class “gcal”
{recurs}
Shows the recurrence status of the event. (Daily, Weekly, etc.)
{repeats}
Shows the number of repetitions of the event.
{details}
Provides a link to an auto-generated page containing all information on the given event. Requires that the site URL has been provided on the Settings page
{details_link}
Raw URL for the details link; empty if target URL not defined.
{linking}
Provides a link to the defined event URL when present, otherwise the {details} link. Requires that the site URL has been provided on the Settings page
{linking_title}
Like {link_title}, but uses {linking} instead of {link}.
{event_tickets}
URL to ticketing for event.
{event_registration}
Registration information about this event.
{event_status}
Displays the current status of the event: either “Published” or “Reserved” – primary used in email templates.

Location Template Tags

{location}
Displays the name of the location of the event.
{street}
Displays the first line of the site address.
{street2}
Displays the second line of the site address.
{city}
Displays the city for the location.
{state}
Displays the state for the location.
{postcode}
Displays the postcode for the location.
{region}
Shows the custom region entered for the location.
{country}
Displays the country for the event location.
{sitelink}
Output the URL for the location link.
{phone}
Output the stored phone number for the location.
{sitelink_html}
Output a hyperlink to the location’s listed link with default link text.
{hcard}
Displays the event address in hcard format.
{link_map}
Displays a link to a Google Map of the event, if sufficient address information is available. If not, will be empty.
{map_url}
Produces the URL for the Google Map for the event location if sufficient address information is available. If not, will be empty.
{map}
Output Google Map if sufficient address information is available. If not, will be empty.
{location_access}
Unordered list of accessibility options for this location.

Category Template Tags

{category}
Displays the name of the category the event is in.
{icon}
Produces the address of the current event’s category icon.
{icon_html}
Produces the HTML for the current event’s category icon.
{color}
Produces the hex code for the current event’s category color.
{cat_id}
Displays the ID for the category the event is in.

Special use Template Tags

{dateid}
A unique ID for the current instance of an event.
{id}
The ID for the event record associated with the current instance of an event.

Quick Start Guide

Main Calendar Shortcode

Example Customized Shortcode

This shortcode shows the one-week view of the calendar on a post or page including all categories and the category key, in a list format. The standard previous/next navigation will be included above the calendar, the link to the print format will be shown below.

Common shortcode attributes:

  • category: Names or IDs of categories in the calendar, comma or pipe separated.
  • format: “list” or “mini”; exclude to show a calendar grid.
  • above,
    below: Comma-separated list of navigation to display above or below the calendar. Available: nav, toggle, jump, print, key, feeds, exports, timeframe. Order listed determines order displayed. Defaults in settings will be used if the attribute is blank. Use none to hide all.
  • time: Set to “week” to show a one week view or to “day” to show a single day view. Any other value will show a month view. (Day view always shows as a list.)
  • ltype: Type of location data to restrict by.
  • lvalue: Specific location information to filter to.
  • author: Author or comma-separated list (usernames or IDs) to show events from.
  • host: Host or comma-separated list (usernames or IDs) to show events from.
  • year: A year to start the calendar display at. (e.g. 2016)
  • month: A month to start the calendar display at. (e.g. 08)
  • day: A day to start the calendar display at. (e.g. 28)
  • id: String to give shortcode a unique ID.
  • months: Months to show in list view.

Displays the output of the Upcoming Events widget. before and after are numbers; type is either “event”, “days”, or “custom” and category and author work the same as in the main calendar shortcode. Templates use the template codes listed below. fallback provides text if no events meet your criteria. Order sets sort order for the list – ascending (asc) or descending (desc). show_today indicates whether to include today’s events in the list. Skip is how many events to skip in the list. Use from and to with type=”custom” to display events between two specific dates The keyword “today” in the to attribute will give you all events between the from date and the current date.

Displays the output of the Today’s Events widget, with five configurable attributes: category, author, template, date, and fallback text.

Upcoming Events and Today’s Events can also be configured as widgets.

Displays a single event and/or all dates for that event. If template is set to a blank value, will only display the list of occurrences. If the list attribute is set blank, will only show the event template

Calendar Filter Shortcodes

Displays all available filters as a single form. The show attribute takes three keywords: categories, locations, and access, to indicate which filters to show and in what order. Use “target_url” to pass the URL for a page where results should be shown. The target page should use the “[my_calendar]” shortcode. Use “ltype” to change the type of data being searched.

List of event locations, as a list of links or as a select form. show is either list or form, type is saved (to show items from stored locations), or custom (to show options configured in location settings). datatype must be the type of data your limits are using: name (business name), city, state, country, zip (postal code), or region.

List of event categories, either as a list of links or as a select dropdown form. The show attribute can either be list or form.

Simple search form to search all events. url attribute to pass a custom search results page, otherwise your My Calendar URL.

Show an event happening right now. Will only ever show one event, which will be the first event returned by checking which events are happening at the moment. Pass a category ID or name to limit by category.

List of filterable accessibility services, either as a list of links or as a select dropdown form. The show attribute can either be list or form.

Information Listing Shortcodes

List of locations. datatype is the type of data displayed; all lists include a link to the map to that location. In addition to basic location information as in the above shortcode, you can also use “hcard” to display all available location information. Use template to show customized data, sorted by the datatype value.