search

stephenharris / Event-Organiser

WordPress plug-in, Event Organiser, development repository
http://wordpress.org/extend/plugins/event-organiser/
GNU General Public License v3.0
99 stars 76 forks source link

readme

Event Organiser

Contributors: stephenharris
Donate link: http://www.wp-event-organiser.com/donate
Tags: events, event, event categories, event organizer, events calendar, event management, ical, locations, google map, OpenStreetMap, widget, venues, maps, gigs, shows,
Requires at least: 3.8.0
Tested up to: 5.8.1
Stable tag: {{version}}
License: GPLv3

Create and maintain events, including complex reoccurring patterns, venue management (with Google Maps or OpenStreetMap), calendars and customisable event lists

Description

Event Organiser adds event management that integrates well with your WordPress site. By using WordPress' in-built 'custom post type', this plug-in allows you to create events that have the same functionality as posts, while adding further features that allow you to manage your events. This includes the possibility of repeating your event according to complex schedules and assign your events to venues. This can all be done through an intuitive user interface, which allows you to view your events in the familiar WordPress list or in a calendar page in the admin area.

User Docs | Function Reference | Forums | Demo | Booking Add-on

Available Extensions

A full list of available extensions can be found here.

Features

For the user

For the developer

Localisation

A big thank you to those who have provided translations for Event Organiser. If you wish to help out with translating the plug-in, you can do so here.

Installation

Installation is standard and straight forward.

  1. Upload event-organiser folder (and all it's contents!) to the /wp-content/plugins/ directory
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Check Settings > Event Organiser

Frequently Asked Questions

How to create an event

Events behave very similarly to standard posts. To create a event, select the 'Add New' submenu from 'Events' menu. The chief difference between events and post is the 'Event Details' metabox which sets the date and venue data related to the event.

You can also add events in the Calendar view in a manner similiar to Google Calendar. By selecting one (or multiple) days (in month mode) or times (in week/day mode) you can create an event that spans the selected period.

The Event Pages Don't Look Right

Unfortunately its impossible for the default templates to work with every theme. Occasionally, they simply don't work well with a given theme - the event content might not appear right, or the sidebar might seem displaced. The solution is to edit the default templates to fit in with your theme (you can use your theme's own templates as a guideline). You can find more information here

How do I display events?

Events are automatically displayed on the events page: try www.your-wordpress-site.com/?post_type=event (If you have permalinks enabled these will have 'prettier' versions). Similarly there are venue and event category pages. Each of these pages have their own associated template which are present in the template sub-directory of the Event Organiser plug-in folder. To override the default templates, simply create the appropriately named files in your theme directory.

Widgets The plug-in also provides the following widgets (see widget documentation):

Shortcodes Among others, the plug-in also provides the following shortcodes (see shortcode documentation):

Template Functions Finally, the plug-in provides a function eo_get_events() which is similiar to WordPress' get_posts(). It returns an array of post objects (where the posts are events), and this can be used to display events through editing your theme. The usual WordPress functions for display associated information (author, title etc) are still available to you, and the plug-in provides a similar set of functions to display event related data (dates, venues etc). See the documentation for more information.

The full calendar doesn't display any events

The calendar should display all published events. If you find the calendar doesn't appear this is usually caused by the theme you are using, and is verifiable by temporarily switching to the TwentyEleven theme. If the theme is the cause this is normally because:

If the calendar does appear, but gets stuck loading, the cause is usually the AJAX response. If your site is in 'debug' mode - this can be due to error messages from other plug-ins being printed. You can view the AJAX response in your browsers console (E.g. Firefox's firebug or Chrome's dev tools). If you are still unable to determine the cause of the problem, or how to fix, please use the plug-in forums with a link to your site and I'll take a look.

I cannot navigate between months on the widget calendar

If clicking on the 'next' month causes the page to reload - the javascript has not been loaded. This is usually because the theme does not call wp_footer in the footer.

If the calendar simply does not respond this is usually because your theme does not allow widgets to add their own ID and classes. Somewhere in the theme folder your theme will make use of register_sidebar() (probably in functions.php. It should look something like:

register_sidebar(array(
  'name' => __( 'Side bar name' ),
  'id' => 'sidebar-id',
  'description' => __( 'Widget area description' ),
  'before_title' => '<h1>',
  'after_title' => '</h1>',
  'before_widget' => '<div id="%1$s" class="widget %2$s">',
  'after_widget' => '</div>',
));

Notice the %1$s and %2$s in the before_widget argument. These allow the widget to add their own ID and classes to the widget. If your theme does not use class="widget %2$s" (they should!) the month navigation for the widget calendar will not work.

If you are still unable to determine the cause of the problem, or how to fix, please use the plug-in forums with a link to your site and I'll take a look.

What ShortCodes are available?

Event Organiser provides the following shortcodes:

More information on shortcodes is available here

Screenshots

1. Event admin screen

Event admin screen

2. Venue admin screen

Venue admin screen

3. Event details metabox, showing the full reoccurrence options and venue selection

Event details metabox, showing the full reoccurrence options and venue selection

4. Venue editing screen, with Google Maps

Venue editing screen, with Google Maps

5. Calendar View screen

Calendar View screen

6. Calendar shortcode (using TwentyThirteen)

Calendar shortcode (using TwentyThirteen)

7. Calendar shortcode when viewed on a mobile device (using TwentyFourteen)

Calendar shortcode when viewed on a mobile device (using TwentyFourteen)

8. Events list (using TwentySixteen)

Events list (using TwentySixteen)

Changelog

3.10.8 - 13th October 2021

3.10.7 - 11th June 2021

3.10.6 - 17th May 2021

3.10.5 - 7th March 2021

3.10.4 - 19th January 2021

3.10.3 - 15th January 2021

3.10.2 - 13th September 2020

3.10.1 - 14th August 2020

3.10.0 - 22nd July 2020

3.9.1 - 28th May 2020

3.9.0 - 8th January 2020

3.8.6 - 18th November 2019

3.8.5 - 7th November 2019

3.8.4 - 5th November 2019

3.8.3 - 31st August 2019

3.8.2 - 6th August 2019

3.8.1 - 26th July 2019

3.8.0 - 15th July 2019

3.7.6 - 6th March 2019

3.7.5 - 1st March 2019

3.7.4 - 26th August 2018

3.7.3 - 13th July 2018

3.7.2 - 8th June 2018

3.7.1 - 31st May 2018

3.7.0 - 25th May 2018

3.6.5 3rd April 2018

3.6.4 26th March 2018

3.5.1 14th November 2017

3.4.1 18th October 2017

3.3.0 12th September 2017

3.2.0 23rd August 2017

3.1.4 - 9th September 2016

3.1.3 - 23rd July 2016

3.1.2 - 20th July 2016

3.1.1 - 8th July 2016

3.1.0 - 23rd May 2016

3.0.5 - 31st March 2016

3.0.4 - 3rd March 2016

3.0.3 - 24th Feburary 2016

3.0.2 - 12th Feburary 2016

3.0.1 - 4th February 2016

3.0.0 - 29th January 2016

Event Organiser now requires WordPress 3.8.0+ or better

fullCalendar

API

Google map

Theme compatability

Templates

iCal feed

Widget

General

Accessibility This is an ongoing process, and any bug reports, feature suggestions and pull requests are welcome in this respect.

2.13.7 - 9th December 2015

2.13.6 - 9th August 2015

2.13.5 - 25th July 2015

2.13.4 - 13th June 2015

2.13.3 - 2nd June 2015

2.13.2 - 23rd May 2015

2.13.1 - 7th May 2015

2.13.0 - 1st May 2015

2.12.5 - 21st April 2015

2.12.4 - 19th March 2015

2.12.3 - 13th March 2015

2.12.2 - 10th March 2015

2.12.1 - 2nd March 2015

2.12.0 - 20th February 2015

You are strongly recommended to update to 2.12.0 before updating to WordPress 4.2 (to be released). Please see this post

2.11.1 - 28th January 2015

2.11.0 - 24th January 2015

2.10.0 - 22nd December 2014

2.9.2 - 31st October 2014

2.9.1 - 14th October 2014

2.9.0 - 16th September 2014

2.8.6 - 4th September 2014

2.8.5 - 22nd August 2014

2.8.4 - 14th August 2014

2.8.3 - 5th August 2014

2.8.2 - 26th June 2014

2.8.1 - 24th June 2014

2.8 - 18th June 2014

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7

2.6

2.5.1

2.5

2.4

2.3.2

2.3.1

2.3

2.2.2

2.2.1

2.2

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1

2.0.2

2.0.1

2.0

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8

1.7.4

1.7.3

1.7.2

1.7.1

1.7

1.6.3

1.6.2

1.6.1

1.6

A special thanks to kuemerle and csaba-erdei.

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5

1.4.2

1.4.1

1.4

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3

1.2.4

1.2.3

1.2.2

1.2.1

1.2

1.1.1

A minor update, fixing a few bugs and improving the (admin and public) calendars' performance. The bug which meant calendars and the calendar widget couldn't be displayed together is now fixed. For a full list of alterations see here.

1.1

Improved admin calendar navigation, with category/venue filters. Public version of the 'admin calendar' now available as a shortcode. You can now import events from an ICAL file. Further details included in the ics export file. The venue content editor is now fully featured. Venue descriptions now understand shortcodes. Fixed a few bugs.

1.0.5

Fixed export bug.

1.0.4

Introduced warning messages for unsupported PHP / WP versions and missing tables. Updated templates to work with more themes. Updated event table install.

1.0.3

Fixed 'blank screen of death' for unsupported versions (WP < 3.3). The plug-in will still not operate correctly for versions before 3.3.

1.0.2

Fixed ics exporter and deactivation/uninstall

1.0.1

Minor bug fixes and readme update.

1.0.0

Initial release

Upgrade Notice

2.13.7

This fixes a bug with the event list widget on WordPress 4.4 Advance notice: As of 3.0.0 Event Organiser shall require WordPress 3.8 or better.