The Events Calendar Shortcode

Description

This plugin adds a shortcode for use with The Events Calendar Plugin (by Modern Tribe).

With this plugin, just add the shortcode on a page to display a list of your events. For example to show next 8 events in the category festival:

[ecs-list-events cat="festival" limit="8"]

Shortcode Options:

  • Basic shortcode: [ecs-list-events]
  • cat – Represents single event category. [ecs-list-events cat='festival'] Use commas when you want multiple categories [ecs-list-events cat='festival, workshops']
  • limit – Total number of events to show. Default is 5. [ecs-list-events limit='3']
  • order – Order of the events to be shown. Value can be ‘ASC’ or ‘DESC’. Default is ‘ASC’. Order is based on event date. [ecs-list-events order='DESC']
  • date – To show or hide date. Value can be ‘true’ or ‘false’. Default is true. [ecs-list-events eventdetails='false']
  • venue – To show or hide the venue. Value can be ‘true’ or ‘false’. Default is false. [ecs-list-events venue='true']
  • excerpt – To show or hide the excerpt and set excerpt length. Default is false.
    • [ecs-list-events excerpt='true'] //displays excerpt with length 100
    • [ecs-list-events excerpt='300'] //displays excerpt with length 300
  • thumb – To show or hide thumbnail image. Default is false. [ecs-list-events thumb='true'] //displays post thumbnail in default thumbnail dimension from media settings.
  • You can use thumbwidth and thumbheight to customize the thumbnail size [ecs-list-events thumb='true' thumbwidth='150' thumbheight='150'] or thumbsize for a registered WordPress size [ecs-list-events thumb='true' thumbsize='large']
  • message – Message to show when there are no events. Defaults to ‘There are no upcoming events at this time.’
  • viewall – Determines whether to show ‘View all events’ or not. Values can be ‘true’ or ‘false’. Default to ‘true’ [ecs-list-events cat='festival' limit='3' order='DESC' viewall='false']
  • contentorder – Manage the order of content with commas. Default to title, thumbnail, excerpt, date, venue. [ecs-list-events cat='festival' limit='3' order='DESC' viewall='false' contentorder='title, thumbnail, excerpt, date, venue']
  • month – Show only specific Month. Type 'current' for displaying current month only or 'next' for next month [ecs-list-events cat='festival' month='2015-06']
  • past – Show Outdated Events. [ecs-list-events cat='festival' past='yes']
  • key – Hide the event when the start date/time has passed [ecs-list-events cat='festival' key='start date']
  • orderby – Order by end date [ecs-list-events orderby='enddate']

Additional options and benefits in the pro version

  • design – Shows improved design by default, ‘compact’ for a more compact listing, ‘calendar’ for a monthly calendar view, ‘columns’ to show events horizontally in columns, or ‘grouped’ to group events by day
  • days – Specify how many days in the future, for example [ecs-list-events days= »1″] for one day or [ecs-list-events days= »7″] for one week
  • date – Show only events for a specific day [ecs-list-events date=’2017-04-16′]
  • tag – Filter by one or more tags. Use commas when you want to filter by multiple tags.
  • city, state, country – Display events by location.
  • featured only – Show only events marked as « featured »
  • id – Show a single event, useful for displaying details of the event on a blog post or page
  • description – Use the full description instead of the excerpt of an event in the listing
  • raw_description – Avoid filtering any HTML (spacing, links, bullet points, etc) in the description
  • raw_excerpt – Avoid filtering any HTML (spacing, links, etc) in the excerpt
  • year – Show only events for a specific year
  • date range – Show only events between certain days
  • timeonly – To show just the start time of the event. [ecs-list-events timeonly=’true’]
  • offset – Skip a certain number of events from the beginning, useful for using multiple shortcodes on the same page (with ads in between) or splitting into columns
  • custom design – Create one or more of your own templates for use with the shortcode
  • hiderecurring – To only show the first instance of a recurring event, set to ‘true’

View more Pro features

This plugin is not developed by or affiliated with The Events Calendar or Modern Tribe in any way.

Captures d’écran

  • After adding the plugin, add the shortcode where you want the list of events to appear in the page
  • Events will appear in a list
  • Many settings you can use in the shortcode to change what details appear in the events listing

Installation

  1. Install The Events Calendar Shortcode Plugin from the WordPress.org repository or by uploading the-events-calendar-shortcode folder to the /wp-content/plugins directory. You must also install The Event Calendar Plugin by Modern Tribe and add your events to the calendar.

  2. Activate the plugin through the Plugins menu in WordPress

  3. If you don’t already have The Events Calendar (the calendar you add your events to) you will be prompted to install it

You can then add the [ecs-list-events] shortcode to the page or post you want to list events on. Full list of options available in the documentation.

FAQ

What are the shortcode options?
  • Basic shortcode: [ecs-list-events]
  • cat – Show events from an event category [ecs-list-events cat='festival'] or specify multiple categories [ecs-list-events cat='festival, workshops']
  • limit – Total number of events to show. Default is 5. [ecs-list-events limit='3']
  • order – Order of the events to be shown. Value can be ‘ASC’ or ‘DESC’. Default is ‘ASC’. Order is based on event date. [ecs-list-events order='DESC']
  • date – To show or hide date. Value can be ‘true’ or ‘false’. Default is true. [ecs-list-events eventdetails='false']
  • venue – To show or hide the venue. Value can be ‘true’ or ‘false’. Default is false. [ecs-list-events venue='true']
  • excerpt – To show or hide the excerpt and set excerpt length. Default is false. [ecs-list-events excerpt='true'] //displays excerpt with length 100
    excerpt=’300′ //displays excerpt with length 300
  • thumb – To show or hide thumbnail image. Default is false. [ecs-list-events thumb='true'] //displays post thumbnail in default thumbnail dimension from media settings.
  • thumbsize – Specify the size of the thumbnail. [ecs-list-events thumb='true' thumbsize='large']
  • thumbwidth / thumbheight – Customize the thumbnail size in pixels [ecs-list-events thumb='true' thumbwidth='150' thumbheight='150']
  • message – Message to show when there are no events. Defaults to ‘There are no upcoming events at this time.’
  • viewall – Determines whether to show ‘View all events’ or not. Values can be ‘true’ or ‘false’. Default to ‘true’ [ecs-list-events cat='festival' limit='3' order='DESC' viewall='false']
  • contentorder – Manage the order of content with commas. Default to title, thumbnail, excerpt, date, venue. [ecs-list-events cat='festival' limit='3' order='DESC' viewall='false' contentorder='title, thumbnail, excerpt, date, venue']
  • month – Show only specific month (in YYYY-MM format). Type 'current' for displaying current month only or 'next' for next month. [ecs-list-events cat='festival' month='2015-06']
  • past – Show Outdated Events. [ecs-list-events cat='festival' past='yes']
  • key – Hide events when the start date has passed [ecs-list-events cat='festival' key='start date']
  • orderby – Change the ordering to the end date [ecs-list-events orderby="enddate"]

With The Events Calendar Shortcode PRO you also get the following options:

  • design – Shows improved design by default. Set to ‘standard’ for the regular one, ‘compact’ for a more compact listing, ‘calendar’ for a monthly calendar view, ‘columns’ to show a horizontal/columns/photo view, or ‘grouped’ to group events by day
  • days – Specify how many days in the future, for example [ecs-list-events days="1"] for one day or [ecs-list-events days="7"] for one week
  • tag – Filter by one or more tags. Use commas when you want to filter by multiple tags.
  • id – Show a single event, useful for displaying details of the event on a blog post or page
  • location (city, state/province, country) – Display events by location. Use commas when you want to include events from multiple (ie. country=’United States, Canada’)
  • description – Use the full description instead of the excerpt of an event in the listing
  • raw_description – Avoid filtering any HTML (spacing, links, bullet points, etc) in the description
  • raw_excerpt – Avoid filtering any HTML (spacing, links, etc) in the excerpt
  • featured only – Show only events marked as « featured »
  • date – Show only events for a specific day [ecs-list-events date='2017-04-16']
  • year – Show only events for a specific year [ecs-list-events year='2017']
  • date range – Show only events between certain days [ecs-list-events fromdate='2017-05-31' todate='2017-06-15']
  • timeonly – To show just the start time of the event. [ecs-list-events timeonly='true']
  • offset – Skip a certain number of events from the beginning, useful for using multiple shortcodes on the same page (with ads in between) or splitting into columns
  • custom design – Create one or more of your own templates for use with the shortcode
  • filter bar – Allow the user to filter the events shown in the full calendar design (ie. by category, state/province, country, venue, etc)
  • hiderecurring – To only show the first instance of a recurring event, set to ‘true’

Get The Events Calendar Shortcode PRO

How do I use this shortcode in a widget?

You can put the shortcode in a text widget, though not all themes support use of a shortcode in a widget.

If a regular text widget doesn’t work, put the shortcode in a Visual Editor Widget.

What are the classes for styling the list of events?

By default the plugin does not include styling. Events are listed in ul li tags with appropriate classes for styling with a bit of CSS.

  • ul class= »ecs-event-list »
  • li class= »ecs-event » and « ecs-featured-event » (if featured)
  • event title link is H4 class= »entry-title summary »
  • date class is time
  • venue class is venue
  • span .ecs-all-events
  • p .ecs-excerpt

Want a better looking design without knowing any CSS? Check out The Events Calendar Shortcode PRO

How do I include a list of events in a page template?

include echo do_shortcode(« [ecs-list-events] »);

Put this in the template where you want the events list to display.

How do I include a monthly calendar view instead of a list?

The pro version of the plugin has the option to put design="calendar" in the shortcode to show a calendar view of the events you want.

Avis

Poor Formatting

For me, the formatting was so poor, this plugin was a waste of time. Supposedly, you can apply CSS styling — but I found the selectors to be unclear, and I was unable to apply appropriate margins to the bullet list. Being as that may be, I would have also preferred the event date to be right under the title, no line spaces. This plugin is too much trouble, for little gain. Personally, I would never pay $29 a year just for styling — but it looks like the developer is hopeful.

Fantastic, Great Customer Support

I love this plug in. It did exactly what the Event’s Calendar couldn’t, and I now have a beautiful page detailing only upcoming events in an efficient and easy-to-peruse manner. This way my users don’t have to click through a month-by-month view in an attempt to find upcoming events.

It also looks great in my widget side bar.

I really appreciate what you’ve done Brian and wish you all the best!

AWESOME

Really good plugin, I use the Pro Version. Totally worth it!

Lire les 49 avis

Contributeurs & développeurs

« The Events Calendar Shortcode » est un logiciel libre. Les personnes suivantes ont contribué à cette extension.

Contributeurs

“The Events Calendar Shortcode” a été traduit dans 2 locales. Remerciez l’équipe de traduction pour ses contributions.

Traduisez « The Events Calendar Shortcode » dans votre langue.

Le développement vous intéresse ?

Parcourir le code, consulter le SVN dépôt, ou s’inscrire au journal de développement par RSS.

Journal

1.10.1

  • Fixing error with very old versions of PHP

1.10

  • Fix for multi-word category names not working with the « cat » option
  • Option to show « powered by » link

1.9

  • Adds check for minimum WordPress and PHP version
  • Adds a link to a short tutorial video
  • Changes first example shortcode so it’s easier to copy/paste

1.8

  • Adds new orderby=’title’ option
  • Fixes resetting the WordPress global query instead of just the post data

1.7.3

  • Hide the « at » when using venue=’true’ and an event has no venue
  • Adds additional WordPress filters to hide certain events

1.7.2

  • Adds the ability to use schema=’false’ in the shortcode to hide the schema output

1.7.1

  • Fix for month option where there’s an all-day event the first day of the next month
  • Fix for « There are no events » string not being translated automatically into other languages

1.7

  • Adds structured data to the shortcode output (great for SEO and people finding your events)

1.6.1

  • Added ecs-featured-event class if event is featured
  • Internal changes to filtering by one or more categories

1.6

  • Changes default ordering by the start date, use orderby= »enddate » for previous default ordering

1.5.3

  • Fixes translation of the « View all events » link into other languages
  • Adds orderby parameter to order by start date, but still show events until the end date has passed

1.5.2

  • Adds ‘next’ option for showing the next month of events

1.5.1

  • Adds thumbsize option (ie. medium, large, thumbnail, full)

1.5

  • Adds ability to translate the plugin into local languages
  • Additional description of options

1.4.2

  • Additional filter for changing the link for an event
  • Adds category CSS classes for each event, so you can format each category differently

1.4.1

  • Additional filters for formatting a single event

1.4

  • Checks for whether The Events Calendar is installed
  • Additional filters
  • Improved design of shortcode help page

1.3

  • Fixes issue with « viewall » showing the events twice
  • Fixes time zone issue by using current_time() instead of date()
  • Hides events that are marked ‘hide from listing’
  • Switches to tribe_get_events() to get the events
  • Removes the … from the end of the excerpt if less than the excerpt length
  • Adds date_thumb option
  • Adds additional filters

1.2

  • Updates author/description (Event Calendar Newsletter / Brian Hogg Consulting)

1.0.11

Add Link to Thumbnail
merge pull request from d4mation -Replaced extracted variables with $atts as using extract was deprecated
=1.0.10 =
Minor Error Change – fix name and slug

1.0.9

Minor Error Change – Multiple Categories

1.0.8

Add options : multi-categories – Thanks to sujin2f

1.0.7

Add options : contentorder, month, past, key – Thanks to sujin2f

1.0.6

Fix missing ul

1.0.5

  • Add excerpt and thumbnail – Thanks to ankitpokhrel

1.0.2

  • Add venue to shortcode – Thanks to ankitpokhrel

1.0.1

  • Fix Firefox browser compatibility issue

1

  • Initial Release