This repository has been archived by the owner on Oct 31, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
README.txt
132 lines (95 loc) · 6.02 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
=== Church Community Builder Core API ===
Contributors: jaredcobb
Tags: ccb, church, api, chms
Requires at least: 4.6.0
Tested up to: 5.3.0
Stable tag: 1.0.8
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Provides a core integration to the Church Community Builder API.
== Description ==
Church Community Builder Core API *synchronizes* your church data to WordPress [custom post types](https://codex.wordpress.org/Custom_Post_Types).
This plugin is geared toward Developers, Designers, and Site Administrators who aren't afraid to get into a little bit of code.
Find out more at [https://www.wpccb.com](https://www.wpccb.com) and [https://github.com/jaredcobb/ccb-core](https://github.com/jaredcobb/ccb-core).
= Why Use This Plugin? =
One of the biggest challenges with getting your Church Community Builder data onto your site is the actual API integration. This plugin does all of the heavy lifting for you. Once your church data is securely synchronized you can use it freely in your theme, widgets, or even your own plugins!
= Features =
* Get your Public Groups
* Get your Public Events
* Auto-synchronize (set it and forget it)
* Manually synchronize anytime
* Cached data (extremely fast)
* Works in the background (never interrupts you or your visitors)
* Secure (API communication is encypted, and so are your credentials)
= Documentation =
Extensive developer documentation is available on the [GitHub wiki](https://github.com/jaredcobb/ccb-core/wiki).
== Installation ==
1. Upload the entire plugin folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. You'll find a settings page in a sidebar menu titled "CCB Core API"
1. Enter your Church Community Builder software subdomain
1. Enter your Church Community Builder API credentials
1. Enable the synchronizations you'd like
== Frequently Asked Questions ==
= I installed this plugin and my site doesn't look any different =
This plugin has a very specific task: It gets some of your Church Community Builder data and imports it into your WordPress database (as custom post types). A developer (or advanced WordPress administrator) will need to alter your theme to *take advantage* of this data.
= Some of my groups in Church Community Builder aren't being synchronized =
You'll need to ensure your [group settings](https://churchcommunitybuilder.force.com/s/article/2102903) allow the group to be publicly listed. A great way to cross reference if your group is publicly visible is to visit *yoursubdomain*.ccbchurch.com/w_group_list.php and see if the missing group shows up there.
== Screenshots ==
1. screenshot-1.png
2. screenshot-2.png
== Changelog ==
= 1.0.8 =
* Implements OpenSSL based encryption for better support across platforms.
* Fixes a bug where some environments couldn't save API credentials.
= 1.0.7 =
* Fix for a bug where auto-sync was failing when group images are enabled.
* PHP 7.2 and above compatibility improvements.
* Stronger encryption methods for PHP 7.2 and above.
* Performance improvements in how the plugin loads and runs.
* Compatible with Gutenberg, WordPress 5.0.
= 1.0.6 =
* Fixes a bug where admin libraries may not be loaded under some cron contexts.
= 1.0.5 =
* Fixes a bug where events could be duplicated on subsequent synchronizations.
= 1.0.4 =
* Adds the CCB event id (as post meta) to each instance of a recurring event. This allows individual instances of a recurring event to be associated with each other in WordPress.
= 1.0.3 =
* Featured images associated with synchronized posts now also get deleted when the post is deleted
* A new filter `ccb_core_synchronizer_delete_attachment` has been created to optionally overwrite the default behavior of deleting attachments when posts are deleted
* Any images that are synchronized automatically get a post meta key of `ccb_core` with a value of `true` (in case you need to programmatically query for CCB images in the future)
= 1.0.2 =
* Fixed a bug to allow subdomains with dashes
* Remove PHP 5.4 array syntax from the main plugin file (prevent crashes on PHP < 5.4)
= 1.0.1 =
* Fixed a bug where terms are not populated in some circumstances
* Added checks for minimum PHP and WordPress versions to prevent crashes
= 1.0.0 =
* Official stable release
* *Breaking Changes* - Please note that post type and custom taxonomy names have changed (see [release notes](https://github.com/jaredcobb/ccb-core/wiki/1.0.0-Stable-Release) )
* Fixed broken group images (CCB API query parameter `include_image_link=true`)
* Refactored code to be faster, simpler, and easier to extend
= 0.9.6 =
* Added automatic flushing of rewrite rules when custom post type settings are changed
* Added link to official documentation in README and About page
= 0.9.5 =
* Added an option to import Group Images as the Featured Image (no longer referencing the CCB CDN location which expires quickly)
* Added filters which allow you to customize the API to Custom Post Type mappings:
* `add_filter( 'ccb_include_group_participants' )`, whether or not to ask the API to include group participants in the response
* `add_filter( 'ccb_get_groups_taxonomy_map' )`, ability to customize the taxonomy mapping for groups
* `add_filter( 'ccb_get_groups_custom_fields_map' )`, ability to customize the custom fields mapping for groups
* `add_filter( 'ccb_get_calendar_taxonomy_map' )`, ability to customize the taxonomy mapping for events
* `add_filter( 'ccb_get_calendar_custom_fields_map' )`, ability to customize the custom fields mapping for events
* Added ability to automatically import collections of meta data (for example, multiple group leaders)
= 0.9.4 =
* Added Group "Meet At" address and longitude / latitude coordinates as custom fields
= 0.9.3 =
* Fixed a bug for backwards compatibility with PHP 5.2 servers
= 0.9.2 =
* Added tooltips to some settings to help explain the functionality
* Added better defaults for date ranges
* Updated the plugin web site to https://www.wpccb.com
= 0.9.1 =
* Fixed an issue where some web hosts were not saving encypted passwords
= 0.9.0 =
* Initial release