The event display builder is displayed on the Add Feed page just like the text editor for adding new posts. When the plugin generates the calendar grid or list to display on your page, post or widget, it replaces the shortcodes with the relevant information for each event. You may already be familiar with WordPress shortcodes, as they are widely used in many plugins.
Available Attributes
Some of the Event Builder shortcodes support attributes. Each shortcode will specify which ones work for it, but this is a list of all available attributes to reference.
| Attribute | Description | Choices |
|---|---|---|
| html | Whether or not to parse HTML entered in the relevant field. | true, false |
| markdown | Whether or not to parse Markdown entered in the relevant field. | true, false |
| limit | The word limit for the field. | A positive number |
| format | The date / time format to use. | A PHP date format string |
| newwindow | Whether or not the link should open in a new browser window / tab. | true, false |
| precision | The precision to use for time differences in human-readable format. | A positive number |
| offset | An offset (in seconds) to apply to a date / time before it is displayed. | A number (positive or negative) |
| autolink | Whether or not to automatically make URLs entered into the description of an event into “clickable” links. | true, false |
Event Information Shortcodes
These are the basic shortcodes that are replaced with event information when the plugin generates the grid or list.
| Shortcode | Description | Attributes |
|---|---|---|
| [event-title] | Displays the event title | html, markdown |
| [start-time] | Displays the start time of the event. | offset |
| [start-date] | Displays the start date of the event. | offset |
| [start-custom] | Displays the start date / time of the event. | format, offset |
| [start-human] | Displays the amount of time until the event starts, or how long ago it started (the difference between ‘now’ and the start time of the event) in human-readable format, such as ‘1 hour’, ‘4 days’, ’15 mins’. | precision, offset |
| [end-time] | Displays the end time of the event. | offset |
| [end-date] | Displays the end date of the event. | offset |
| [end-custom] | Displays the end date / time of the event. | format, offset |
| [end-human] | Displays the amount of time until the event ends, or how long ago it ended (the difference between ‘now’ and the end time of the event) in human-readable format, such as ‘1 hour’, ‘4 days’, ’15 mins’. | precision, offset |
| [location] | Displays the location of the event. | html, markdown |
| [maps-link]…[/maps-link] | Anything that you enter between the opening and closing tags of this shortcode (including further shortcodes) will be shown as a link to Google Maps, using the location of the event as a search parameter. | newwindow |
| [description] | Displays the event description. | html, markdown, limit |
| [link]…[/link] | Anything that you enter between the opening and closing tags of this shortcode (including further shortcodes) will be shown as a link to the Google Calendar page for the event. | newwindow |
| [url] | Outputs the raw URL to the Google Calendar page for the event. | |
| [length] | Displays the length of the event, in human-readable format. | precision |
| [event-id] | Outputs the unique identifier assigned to an event. |
Feed Information Shortcodes
These shortcodes are replaced with the relevant information about the feed the event comes from.
| Shortcode | Description |
|---|---|
| [feed-title] | Displays the title of the feed from which the event comes. |
| [feed-id] | Outputs the ID of the feed from which the event comes. |
| [cal-id] | Outputs the calendar ID, which uniquely identifies the calendar. |
Conditional Shortcodes
Each of the following shortcodes has a condition that must be met for anything between its opening and closing tag to be displayed. If its condition is not met, anything inside it will be ignored (including further shortcodes).
| Shortcode | Condition |
|---|---|
| [if-all-day]…[/if-all-day] | The event is an all-day event. |
| [if-not-all-day]…[/if-not-all-day] | The event is not an all-day event. |
| [if-title]…[/if-title] | The event has a title. |
| [if-description]…[/if-description] | The event has a description. |
| [if-location]…[/if-location] | The event has a location. |
| [if-not-location]…[/if-not-location] | The event does not have a location. |
| [if-tooltip]…[/if-tooltip] | The plugin is currently generating a calendar grid with tooltips. |
| [if-list]…[/if-list] | The plugin is currently generating an events list. |
| [if-now]…[/if-now] | The event is taking place now. |
| [if-not-now]…[/if-not-now] | The event is not taking place now. |
| [if-started]…[/if-started] | The event has started (even if it has also ended). |
| [if-not-started]…[/if-not-started] | The event has not started. |
| [if-ended]…[/if-ended] | The event has ended. |
| [if-not-ended]…[/if-not-ended] | The event has not ended (even if it hasn’t started). |
| [if-first]…[/if-first] | The event is the first of the day. |
| [if-not-first]…[/if-not-first] | The event is not the first of the day. |
| [if-multi-day]…[/if-multi-day] | The event spans multiple days. |
| [if-single-day]…[/if-single-day] | The event starts and ends on the same day. |