Event Attachments
Use the attach="true"
parameter to display attachments with events. Attachments that are browser-friendly images (e.g. JPEG or PNG) will display directly on the page along with the event’s description. Other attachments will display as a clickable download link.
Note for Google Calendar users: Google Calendar handles all attachments as links to a Google Drive page, not direct file links, so images are treated as downloads. Google Drive file permissions apply, so use this setting with caution: if someone who does not have read permission for the file tries to download it, Google will send you an email asking you to authorize their access. If your site is public and receives a large amount of traffic, this could quickly become a nuisance.
Event Descriptions
Use the eventdesc="true"
parameter to display event descriptions. Note: In the month view, descriptions will display on hover; in the list view, descriptions will display in full on the page below the event title (and location/organizer, if shown). In the list view, you can choose to display an excerpt of the description by entering the number of words to show, e.g. eventdesc="12"
. Clicking the excerpt will reveal the full description. Other views always shows the full description.
Event Locations
Use the location="true"
parameter to display event locations (if available). Note: In the month view, locations will display on hover; in the list view, locations will display in full on the page below the event title.
Version 8.10.0 introduced the option to use location="maplinks"
to make event locations automatically convert into a clickable Google Maps link, unless the feed’s LOCATION
field data already contains HTML or a URL. location="true"
is still supported for displaying locations without adding a Google Maps link.
Important:
location="maplinks"
performs a Google Maps search on the exact text of your events’LOCATION
fields. It does not have a way to verify that the value is a real address, so incomplete locations (e.g. conference room names within your office) may yield nonsensical map results.
Event Organizers
Use the organizer="true"
parameter to display event organizer (if available). Note: In the month view, organizers will display on hover; in the list view, locations will display in full on the page below the event title (and location, if shown).
Event URLs (Links)
If the event data contains a URL, the URL can be added to the display as a clickable link in one of two ways. Use the linktitles="true"
parameter to make the event title into a clickable link to that URL. If linktitles
is not used, and eventdesc="true"
is used, then the URL will be displayed as a clickable link after the event description. These links will always open in a new tab/window. If you do not wish to have event URL links appear at all, use nolink="true"
.
Feed Color Coding
You can apply a color to events in your feed by using the color
parameter. This is especially helpful if you have multiple feeds and you want to use color coding to distinguish the feeds within your calendar. Add hex color values to this parameter and they will be applied to your feeds in the same order as the feeds are entered in the url
parameter. For example, if you have three feeds and you want to color them purple, green and orange, you could use color="#800080 #008000 #ffa500"
. The base color will be used as a left border on each event, and a lighter tint of that color will be used as the background on the events. Use a tool like the HTML Color Picker to select hex values, if necessary. (Note: the color
parameter supports either space- or pipe-delimited lists.)
Feed Color Coding Legend
The legendposition
and legendstyle
parameters control the placement and display format of the legend. Use legendposition
to determine where to display the legend relative to the calendar. Valid values are "above"
and "below"
. If omitted or an invalid value, will default to above. Use legendstyle
to determine how to display the legend. Valid values are "block"
, "inline"
and "none"
. If omitted or an invalid value, will default to block.
Feed Labels
By default, each calendar in the color key will be labeled using the title provided in that calendar’s feed. You can override the titles by using feedlabel
. Note that because feed labels may need to contain spaces, the values for this parameter are pipe-delimited |
rather than space-delimited. You can provide custom labels for some feeds and use the default titles as labels for others. For example, if you had three feeds and wanted to keep the default title for the second one, you could use feedlabel="Calendar Label 1||Calendar Label 3"
. (Note two pipes together; this is leaving the second delimited value empty.)
Mask Event Details
In some cases, such as for vacation rental availability, you may not want to show any event details, but simply block out days and times. Use maskinfo="MASK"
, replacing MASK
with the text you wish to display in place of the event title. Event details, location and organizer will also be hidden automatically, regardless of any other settings.
Month Navigation Options
By default, the month view shows a dropdown (select) menu to navigate available months. Add monthnav
with a value of select
, arrows
, both
or compact
(both, inline without header) to change how this is displayed. Applies to month view only.
Month/Year Format
Headers and dropdowns that display a month and year (e.g. “March 2020”) can be customized using formatmonthyear="F Y"
, replacing F Y
with a PHP date format string of your choice. Note: This option only supports month and year characters (F, m, M, n, Y, y), plus spaces, hyphens, periods and slashes. All other formatting characters will be stripped from the output.
Time Display
By default, start times are always displayed, and end times are displayed on hover. To hide all times (for instance, if the times are also in your event description), add the hidetimes="true"
parameter. Conversely, to always display end times (not just on hover), add the showendtimes="true"
parameter.