Calendar Documentation

Learn the basics, and get to know Calendar inside and out.

Calendar 1.x Docs

Managing Calendars

Calendar allows you to group your events into calendars, very similar to popular calendaring apps like Apple Calendar and Google Calendar. Calendars can be customized to have their own fields / field layouts and calendar color.

The calendar area in the control panel displays a list of all existing calendars. You can update or remove existing ones, as well as create new ones here.

WARNING: Removing calendar(s) will also permanently remove ALL associated events!

Calendars List

Create a New Calendar

Calendars allow you to set the following data for each one:

  • Name
  • Handle
    • Auto-generated from Name field
  • Description
  • Color
    • Choose from picker (Calendar also automatically internally generates a lighter and darker version of this color for use in control panel and front end templates)
  • Site Settings #
    • Enable this to set up automatic routing of URL's for your events.
    • Enabling this will allow you to use the Live Preview feature. IMPORTANT: the templates will look for event., not entry. (e.g. event.title, not entry.title).
      • Event URI Format - what the event URLs should look like. You can include tags that output event properties, such as {slug} or {postDate|date("Y")}.
      • Template - The template to use when an event's URL is requested.
  • Show the Title field #
    • Uncheck this to set your own title format, auto-generated from other field(s).
      • Title Format - What the auto-generated event titles should look like. You can include tags that output entry properties, such as {myCustomField}.
  • ICS Description field #
    • Set the custom field which is used for event description in ICS exports.
  • ICS Location field #
    • Set the custom field which is used for event location in ICS exports.
  • Design Field Layout #
    • Works just like regular Craft field layouts. Simply create how you want your event publishing experience to be.
    • Layouts are unique per Calendar.

Calendars also include an option to share calendars with publicly accessible ICS subscription URL, allowing users to subscribe (one way sync) their calendaring app to your sites' calendar(s). To enable this, click on the Share this calendar button next to the applicable calendar(s) on the list view of calendars. Once enabled, you can then copy the ICS URL and share it with whoever you wish (admins, show it publicly, etc).

NOTE: ICS subscriptions currently do not work correctly for Google Calendar. The issue is that there's a "bug" or at least oddity in the way Google Calendar handles events with floating dates compared to all other calendaring apps. Google does not to conform to iCal standards for this for some reason and there isn't a way around it unfortunately.