Skip to content

Pull a list of events from ChurchSuite and embed it in a WordPress post or page.

License

Notifications You must be signed in to change notification settings

gjcourtney/include-churchsuite-events

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 

Repository files navigation

=== Include ChurchSuite Events ===
Contributors: jacksonj04
Tags: churchsuite, events
Requires at least: 4.7
Tested up to: 5.4.1
Stable tag: 1.1
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Donate link: https://whitkirkchurch.org.uk/donate

Gets a list of events from a ChurchSuite site, and includes it as part of a post or page.

== Description ==

Gets a list of events from a ChurchSuite site, and includes it as part of a post or page. Passing of various parameters control date ranges, categories, linking of titles and so-on.

Also embeds a JSON-LD representation of the event, which search engines like Google can use to [do interesting things](https://developers.google.com/search/docs/data-types/event).

== Installation ==

1. Upload the plugin files to the `/wp-content/plugins/plugin-name` directory, or install the plugin through the WordPress plugins screen directly.
1. Activate the plugin through the 'Plugins' screen in WordPress

== Usage ==

To include a list of events, add the `[churchsuite_events]` shortcode to a page.

You _must_ include the `site` parameter, giving your ChurchSuite account ID. For example, for the ChurchSuite site "canterbury.churchsuite.co.uk" you would use:

```[churchsuite_events site="canterbury"]```

You can also use any parameters listed under the *Calendar JSON feed* section of the [ChurchSuite API embed documentation](https://github.com/ChurchSuite/churchsuite-api/blob/master/modules/embed.md#calendar-json-feed). For example:

```[churchsuite_events site="canterbury" category="2" featured="1"]```

will only include events from category '2', which are featured.

There are some additional parameters you can pass:

* `link_titles`: Turn the title of each event in the list into a link to the ChurchSuite event page. Defaults to false.
* `show_date`: Display the dates of events. Defaults to true.
* `show_years`: If set to `always`, will always show the year in each date. If set to `different`, will only show years in dates where they are not the current year. Defaults to false.
* `show_end_times`: Display the time an event is scheduled to end. Defaults to false.
* `show_locations`: Display details of an event's location. Defaults to false.
* `show_descriptions`: Display and event's description if given. Defaults to true.

== Changelog ==

= 1.0 =
* Added a shortcode to embed a list of events from ChurchSuite into a page or post.

About

Pull a list of events from ChurchSuite and embed it in a WordPress post or page.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%