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 short description 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.

Design – Templates

Templates is located under My Calendar > Design > Templates.

My Calendar > Design > Templates

Template Editor

Core Templates

My Calendar > Design > Templates – Core Templates and Custom Templates

The core templates will display event details and appear in five places:

grid
The main grid calendar. The content that appears in the popup window.

list
The list view calendar.

mini
The mini view calendar.

details (single event)
The single event view, or details page.

The core templates are not in use by default.
These are simplified models of what is possible. If you only want to make a minor change to the default template, you can edit the specific template and enable it to put it into use. If you wish to revert to the original output, turn off the template.

You can place a template file in your theme directory and reference it from the My Calendar shortcode. If you have a template file called “template.txt” in your theme directory, it would be referenced as [my_calendar template="template.txt"] in your shortcode.

To enable a core template.
Click the template name. Example: I clicked the grid template name and the grid template code became visible so that I could modify the code. To use the template I would need to click the checkbox “Use this template” (above the code section) and click the Update Template button (below the code section).

My Calendar > Design > Templates – enable grid. Edit Template.

After clicking to “Use this template” and clicking the Update Template button. We will be able to see the grid enabled.

My Calendar > Design > Templates – enabled grid.

Frontend view of the grid popup.
(your before and after grid popup views will likely be different than the examples I show below.)

Before enabling grid view:

My Calendar > Design > Templates – before enabling grid template. Frontend view.

After enabling grid view:

My Calendar > Design > Templates – after enabling grid template. Frontend view.

It clearly shows the difference between disabled and enabled grid view.

Core template code.

Click the code of each core template and see how these are built. It will make it easier to build your own template if you base it on one of the below core templates.

Core Template: used in the details popup in the main calendar view.

<span class="event-time value-title">{time}{endtime before="<span class='time-separator'> - </span><span class='end-time'>" after="</span>"}</span>
{image before="<div class='mc-event-image'>" after="</div>"}
<div class="sub-details">
	{hcard before="<div class='mc-location'>" after="</div>"}
	{excerpt before="<div class='mc-excerpt'>" after="</div>"}
</div>

Core Template: used when viewing events in the main calendar list view.

<span class="event-time value-title">{time}{endtime before="<span class='time-separator'> - </span><span class='end-time'>" after="</span>"}</span>
{image before="<div class='mc-event-image'>" after="</div>"}
<div class="sub-details">
	{hcard before="<div class='mc-location'>" after="</div>"}
	{excerpt before="<div class='mc-excerpt'>" after="</div>"}
</div>

Core Template: used in popups for the mini calendar.

<span class="event-time value-title">{time}{endtime before="<span class='time-separator'> - </span><span class='end-time'>" after="</span>"}</span>
{image before="<div class='mc-event-image'>" after="</div>"}
<div class="sub-details">
	{hcard before="<div class='mc-location'>" after="</div>"}
	{excerpt before="<div class='mc-excerpt'>" after="</div>"}
</div>

Core Template: used on the single event view.

<span class="event-time value-title" title="{dtstart}">{time}<span class="time-separator"> - </span><span class="end-time value-title" title="{dtend}">{endtime}</span></span>
{image before="<div class='mc-event-image'>" after="</div>"}
<div class="event-data">
	{runtime before="<p class='mc-runtime'>" after="</p>"}
	{categories before="<p class='mc-categories'>" after="</p>"}
</div>
<div class="sub-details">
	{hcard before="<div class='mc-location'>" after="</div>"}
	{description before="<div class='mc-description'>" after="</div>"}
	{map before="<div class='mc-map'>" after="</div>"}
</div>

Custom Templates

Click “Add Custom Template” button to create a blank template. We will see this section:

My Calendar > Design > Templates – Add Custom Template

Add a Template Description and code and click the “Add Template” button.

After saving the custom template we will see it listed with a template key. The template key is used as a reference to this template in almost any template attribute. This is an easier and more flexible way to manage templates used in shortcodes.

Event Tags and Location Tags

See the Template Tag Index documentation for a list of various Event, Location and other tags used in My Calendar.

Below the list of Event and Location tags seen in the Design > Templates screen. A Template preview will display to show the enabled core templates or custom template.

Here is an example with the enabled the grid view template.

My Calendar > Design > Templates – Template Preview: Grid

Next: My Calendar > Design > Scripts.