-
Notifications
You must be signed in to change notification settings - Fork 17
/
readme.txt
executable file
·248 lines (138 loc) · 8.42 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
=== CiviCRM Profile Sync ===
Contributors: needle, cuny-academic-commons, kcristiano, tadpolecc
Donate link: https://www.paypal.me/interactivist
Tags: civicrm, buddypress, acf, profile, sync
Requires at least: 4.9
Tested up to: 6.5
Requires PHP: 7.1
Stable tag: 0.6.9a
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Keeps a WordPress User profile in sync with a CiviCRM Contact and integrates WordPress and CiviCRM Entities when using Advanced Custom Fields.
== Description ==
### WordPress Integration
At its simplest, the CiviCRM Profile Sync plugin keeps the "First Name", "Last Name", "Nickname", "Email Address" and "Website" fields of a WordPress User Profile in sync with their corresponding fields in a CiviCRM Contact. The synchronisation takes place regardless of whether the changes are made in WordPress or CiviCRM.
### BuddyPress Integration
The plugin also supports syncing the "First Name" and "Last Name" fields of the WordPress User and CiviCRM Contact with BuddyPress when using the BP xProfile WordPress User Sync plugin. Further integration with BuddyPress is in the pipeline.
### ACF Integration
CiviCRM Profile Sync enables integration between CiviCRM Entities and WordPress Entities with data synced via Advanced Custom Fields.
Whilst ACF integration is not complete in its coverage of the CiviCRM Entities that can be linked, it is fairly comprehensive in its mapping of the built-in CiviCRM Custom Field Types with their corresponding ACF Field Types.
So if, for example, you want to display (or create) a Contact Type on your WordPress site with ACF Fields that contain synced CiviCRM data, this feature could work for you.
Please refer to the [ACF Integration Documentation](https://github.com/christianwach/civicrm-wp-profile-sync/blob/master/docs/ACF.md) for details.
### Form-building with ACF Extended
CiviCRM Profile Sync enables Forms to be built for the front-end of your website with the UI provided by the ACF Extended plugin. These Forms can send their data directly to CiviCRM in a similar (though more limited) way to Caldera Forms CiviCRM.
Form building with ACF Extended is at an early stage of development and is currently limited to submitting data for Contacts, Participants, Activities and Cases. This does, however, provide enough functionality to build some fairly powerful and useful Forms.
Please refer to the [ACFE Form-building Documentation](https://github.com/christianwach/civicrm-wp-profile-sync/blob/master/docs/ACFE.md) for details.
### Requirements
This plugin recommends a minimum of *WordPress 4.9* and *CiviCRM 5.23*. It also requires *BuddyPress 3.0* and the [BP XProfile WordPress User Sync](https://wordpress.org/plugins/bp-xprofile-wp-user-sync/) plugin for syncing "First Name" and "Last Name" with BuddyPress profiles.
### Plugin Development
This plugin is in active development. For feature requests and bug reports (or if you're a plugin author and want to contribute) please visit the plugin's [GitHub repository](https://github.com/christianwach/civicrm-wp-profile-sync).
== Installation ==
1. Extract the plugin archive
1. Upload plugin files to your `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
### Activation
CiviCRM Profile Sync has some particular requirements when it comes to how it is activated. These correspond to the different types of WordPress install:
#### Single Site
Easy - just activate the plugin and you are done!
#### Multisite
Since Users and User metadata are stored in a single place for all sites, CiviCRM Profile Sync's User Profile settings cannot be configured on a per-site basis. This means that (whether CiviCRM Profile Sync is network-activated or not) whichever settings page you go to, you will see CiviCRM Profile Sync settings that are held in common for all sites.
It is, of course, possible to activate CiviCRM in many different ways in Multisite - it could be network-activated, activated on the main site, and/or activated on one or more sub-sites. CiviCRM could also be in Multi-Domain mode or each instance could have its own database. It is recommended that you activate CiviCRM Profile Sync in the same way that CiviCRM is activated.
If CiviCRM is not in Multi-Domain mode, you may have to write some custom code to propagate changed User details to other CiviCRM instances because (depending on the site on which a particular User's details are changed) only the Contact on the CiviCRM instance linked to that site will be updated.
Test early, test often and - above all - test on a development site first.
#### Multi-Network
In Multi-Network, Users and User metadata are stored in one place for all Networks but `site_options` are stored on a per-Network basis. As a result, it is not simple for CiviCRM Profile Sync to store a single collection of User Profile settings for all Networks. You will have to make sure that they are the same across all the Networks where both CiviCRM and this plugin are activated.
A consequence of this architecture is that (depending on how you have set up CiviCRM across the Networks) there may be mismatches between the User data in WordPress and the Contact data in your CiviCRM instances. If CiviCRM is not in Multi-Domain mode, you will have to write some custom code to keep the data synced between WordPress and your CiviCRM instances.
I'll say it again: test early, test often and - above all - test on a development site first.
== Changelog ==
= 0.6.8 =
* Fixes Custom Field sync from CiviCRM to ACF
* Improves PHP8.1+ compatibility
= 0.6.7 =
* Improves caching for Form Actions
* Improves performance in CiviCRM admin
= 0.6.6 =
* Implements a "Use cache" setting for Form Actions
* Adds placeholder setting to fields
= 0.6.5 =
* Enable template tags in the Contact ID field for ACFE forms
= 0.6.4 =
* Fixes spurious Website error log entries
= 0.6.3 =
* Better compatibility with Integrate CiviCRM with WooCommerce
* Fixes creation of empty Website records
= 0.6.2 =
* Fixes potential fatal error on CiviCRM 5.62.x.
* Enable Registration Receipts in ACFE Form Participants action.
= 0.6.1 =
* Allow ACF integration to be disabled.
* Enable "Remove from Group" in ACFE Form Contact action.
= 0.6.0 =
* Fixes missing fields in Form Actions for ACF Extended Forms.
= 0.5.9 =
* Refines deduping in Contact Action for ACF Extended Forms.
* Fixes fatal error in Event Action for ACF Extended Forms.
= 0.5.8 =
* Fixes PHP 8 notices
* Fixes Contact Image uploads
* Enables basic support for "Advanced Filter" in Contact Ref Fields
= 0.5.7 =
* Fixes error on versions of CiviCRM prior to 5.47.
= 0.5.6 =
* Maintenance release.
= 0.5.5 =
* Improves handling of Contact Relationships in ACF Extended Forms.
* Fixes a bug when syncing Attachments.
= 0.5.4 =
* Introduces CiviCRM Activity Attachments Field.
* Introduces CiviCRM Event Action.
* Fixes CiviCRM Settings not showing in ACF Field settings.
= 0.5.3 =
* Fixes error on CiviCRM Activity Action.
= 0.5.2 =
* Improves handling of CiviCRM Websites.
* Improves handling of CiviCRM Contact Images.
* Misc bug fixes.
= 0.5.1 =
* Improves building forms with ACF Extended.
* Misc bug fixes.
= 0.5.0 =
* Enables building forms with ACF Extended.
* Introduces Participant Post Type sync via Advanced Custom Fields.
= 0.4.1 =
* Skips sync when CiviCRM creates a User.
= 0.4 =
* Introduces a Settings Page to set Website Type and Email sync options.
* Enables integration between CiviCRM Entities and WordPress Entities with data synced via Advanced Custom Fields.
= 0.3.3 =
* Sync First Name and Last Name when bulk creating WordPress users.
= 0.3.2 =
* Fix broken method reference
= 0.3.1 =
* Explicitly suspend CiviCRM's callbacks when updating a WordPress user
= 0.3 =
* Introduces a set of "should_be_synced" filters
= 0.2.8 =
* "Bulk Add" functionality rewritten
= 0.2.7 =
* Introduces "civicrm_wp_profile_sync_primary_email_pre_update" action
= 0.2.6 =
* Allows plugin constants to be pre-defined
* Allow plugins to provide a unique username
* Provides new filters to customise bulk import process
= 0.2.5 =
* Makes synced usernames URL-friendly
= 0.2.4 =
* Adds hooks before and after sync operations
* Updates hook references for CiviCRM 4.7.x instances
= 0.2.3 =
* Further fixes to bulk operations logic
= 0.2.2 =
* Minor fixes to bulk operations logic
= 0.2.1 =
* Initial WordPress plugin directory release
= 0.2 =
* Added two-way Website sync
* Fixed unpredictable detection of sync direction
= 0.1 =
* Initial release