Works for both EventKoi Pro and EventKoi Lite. Some attributes are Pro only, as stated in this doc.
This guide covers the eventkoi_calendar shortcode when it is displaying a calendar grid, EventKoi’s default view. If you want the list view instead, see EventKoi Calendar (List View) shortcode: All supported attributes.
Overview
This is the base shortcode:
[eventkoi_calendar]Supported attributes (grid view)
| Attribute | Type | Default | Accepted values | What it does |
|---|---|---|---|---|
id | string | Default calendar | Calendar ID (“2”), comma separated IDs (“2,5,8”), or “all” | Chooses which calendar or calendars to display. EventKoi Lite only supports one calendar, so this only matters for multiple calendars in Pro. |
display | string | “calendar” | “calendar” or “list” | Anything other than “list” renders the grid, so this attribute can be left out for the grid view. |
timeframe | string | “month” | “month”, “week”, or “list” | Sets which tab the embed opens on. This is not the same as display="list". Setting timeframe="list" keeps the full calendar toolbar, including the Month, Week and List toggle, and simply opens on the List tab. display="list" is a separate, standalone list embed with no toolbar at all. |
views | string | empty (all three shown) | Comma separated subset of “month”, “week”, “list” | Controls which tabs appear in the Month, Week, List toggle. Leaving it out shows all three. This only affects the calendar embed, since the standalone list embed has no toggle to restrict. |
filter | bool | Uses the calendar’s own “Show filters” setting | “1”/”0″, “true”/”false”, “yes”/”no”, “on”/”off” | Note: This is an EventKoi Pro feature. Shows or hides the visitor facing filter row, with a dropdown per calendar and per taxonomy in use. Must be given an explicit value. A bare filter with no value is ignored. |
taxonomies | string | empty | Canonical form: slug:id,id;slug2:id | Note: This is an EventKoi Pro feature. Restricts which events the calendar shows to only those tagged with the term IDs you list, whether or not the filter row is visible. If the filter row is also shown, the dropdown for that taxonomy is narrowed to just those terms too, but every other taxonomy’s dropdown stays fully open and is not affected by this attribute at all. A taxonomy’s dropdown only appears if two or more of its terms remain selectable, so pinning down to a single term hides that taxonomy’s dropdown even though the restriction still applies to the events shown. |
Examples
Open on the week tab, with all three tabs still available:
[eventkoi_calendar id="2" timeframe="week"]Only show the Month and List tabs, hiding Week:
[eventkoi_calendar id="2" views="month,list"]The taxonomies attribute requires taxonomies to be set up. Note: Taxonomies are an EventKoi Pro feature. Only show events tagged with two specific locations, using their term IDs:
[eventkoi_calendar id="2" taxonomies="location:12,14"]Note: Filters are an EventKoi Pro feature. Do the same, but also show the filter row so visitors can see the two locations and switch between them.
[eventkoi_calendar id="2" taxonomies="location:12,14" filter="on"]More shortcodes
For the full list of EventKoi shortcodes, see EventKoi Shortcodes Reference Guide: Start Here.