Contributors: needle
Donate link: https://www.paypal.me/interactivist
Tags: civicrm, event organiser, events, sync
Requires at least: 4.9
Tested up to: 6.9
Stable tag: 0.8.8a
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Keep Event Organiser plugin Events in sync with CiviCRM Events.
A WordPress plugin for syncing Event Organiser plugin Events with CiviCRM Events. The plugin syncs Event Organiser Events, Venues and Event Categories to their corresponding entities in CiviCRM.
Important note: Please do not use with CiviCRM 5.47. Your Events in CiviCRM will not respect Daylight Savings offsets.
This plugin is compatible with CiviCRM Profile Sync which enables integration of Custom Fields on CiviCRM Events with ACF Fields attached to the Event Organiser "Event" Post Type.
Important note: Please make sure you have CiviCRM Profile Sync version 0.5 or greater.
CiviCRM Event Organiser supplies a custom ACF Field called "CiviCRM Event ID" which can be used for Event Organiser Events that have a one-to-one correspondence with CiviCRM Events. The field will not work as expected for synced recurring Events.
This ACF Field is useful if, for example, you want to embed an ACF Extended form in an Event Organiser Event template - because the form can access the ID of the synced CiviCRM Event and target it for various operations. Use the syntax {get_field:your_civicrm_event_id_field} to access the CiviCRM Event ID.
There is an issue with Apple Calendar's display of Event Organiser iCal feeds which means that Apple Calendar requires special handling. To solve this, you can install the Event Organiser ICS Feed for Apple Calendar plugin and use its shortcode instead of the one supplied by Event Organiser.
This plugin recommends a minimum of WordPress 4.9 and CiviCRM 5.75 (the latest ESR).
It also requires:
- Event Organiser version 3.0 or greater
- Radio Buttons for Taxonomies to ensure only one event type is selected
Be aware that this plugin is in active development. Test often, test thoroughly and open an issue if you find a problem.
If you are using a version of CiviCRM lower than CiviCRM 5.49.0 then you should apply this patch to get Event Locations to work as expected.
Note: If installing on WordPress multisite, do not network-activate CiviCRM Event Organiser. Only activate it on the sites that Event Organiser is activated - even if Event Organiser is network-activated.
There are two ways to install from GitHub:
If you have downloaded CiviCRM Event Organiser as a ZIP file from the GitHub repository, do the following to install and activate the plugin:
- Unzip the .zip file and rename the enclosing folder so that the plugin's files are located directly inside
/wp-content/plugins/civicrm-event-organiser - Activate the plugin
- Go to the plugin's admin page and follow the instructions
- You are done!
If you have cloned the code from GitHub, it is assumed that you know what you're doing.
Now that you've installed the plugin, you'll want to find out:
CiviCRM Event Organiser provides a number of Shortcodes for adding CiviCRM-related elements.
Use the [ceo_register_link] Shortcode to display a Registration link or button in your page wherever you want. The default link text is "Register" but switches to "Waitlist" when the visitor is not a registered Participant and there is a waitlist with space available.
The attributes that the Shortcode accepts are:
event_idwhich defaults to the currently displayed Event.wrapwhich defaults to no wrapper element - but can be "div" or "button".wrap_classwhich defaults to no classes on the wrapper element.anchor_classwhich defaults to no classes on the anchor element.titlewhich defaults to "Register" for single Events.waitlistwhich defaults to "Waitlist" for single Events.messageswhich defaults to showing messages. Usemessages="no"ormessages="false"to suppress them.
Use the [ceo_register_messages] Shortcode to display the Registration messages separately from the Registration link button. Add messages="no" to your [ceo_register_link] Shortcode to suppress displaying the messages alongside the link or button.
The attributes that the Shortcode accepts are:
event_idwhich defaults to the currently displayed Event.classwhich defaults to no classes on the wrapper element.
Use the [ceo_register_remaining] Shortcode to display the number of remaining places for a CiviCRM Event that has a waitlist.
The attributes that the Shortcode accepts are:
event_idwhich defaults to the currently displayed Event.classwhich defaults to no classes on the wrapper element.formatwhich defaults to e.g. "2 places remaining". Useformat="raw"to display just the number.
There is currently no proper integration with CiviCRM's implementation of repeating events because, at present, CiviCRM does not save (or expose) the schedule that generates the sequence. To get around this limitation, this plugin prioritises a workflow based on creating events in Event Organiser and then (optionally, via the "CiviCRM Settings" metabox on the event's edit page) passing the data over to CiviCRM when requested.
The plugin implements automatic linking to an event's online registration page(s) via the eventorganiser_additional_event_meta hook which has been available since Event Organiser 2.12.5. If you have overridden the Event Organiser template(s) you may have to apply the function to the appropriate hook in your template(s) yourself. See the documentation for the function civicrm_event_organiser_register_links() for details. Thanks to Consilience Media for providing the resources to push this forward.