Commit 5ed7a610 authored by Christian Wach's avatar Christian Wach
Browse files

More instructions

parent 9286b72c
......@@ -4,15 +4,19 @@ A WordPress plugin that allows membership of "network groups" to be managed by o
The groups are synced between CiviCRM and the "Groups" plugin using the "CiviCRM Groups Sync" plugin. These "network-level" groups can be used, for example, to display different Contact Layouts to different users depending on their group membership.
----
#### Notes ####
This plugin has been developed using a minimum of *WordPress 5.0*, *CiviCRM 5.8*, *Groups 2.5.0* and *CiviCRM Groups Sync 0.1.1*.
**Please note:** This plugin is still in early stages of development and may not be production-ready for you. Use at your own risk.
----
#### Installation ####
There are two ways to install from GitHub:
There are two ways to install from GitLab:
###### ZIP Download ######
......@@ -29,18 +33,31 @@ If you have downloaded *CiviCRM Network Groups* as a ZIP file from the GitLab re
If you have cloned the code from GitLab, it is assumed that you know what you're doing.
----
#### Setup ####
In order to use this plugin, you will need to create a number of "Groups" groups on the main site of your WordPress multisite instance. These groups should be synced to CiviCRM using the checkbox provided by the "CiviCRM Groups Sync" plugin.
Once you have created these, note down their IDs (as shown when you hover of their "Edit" links) and create an array of IDs in order of precedence. So, for example, if you created the following groups of decreasing precedence:
* National Leaders ("Groups" ID: 3)
* Regional Leaders ("Groups" ID: 5)
* Local Leaders ("Groups" ID: 6)
1. National Leaders ("Groups" ID: 3)
2. Regional Leaders ("Groups" ID: 5)
3. Local Leaders ("Groups" ID: 6)
Then your array should look like:
`define( 'CIVICRM_NETWORK_GROUPS_PRECEDENCE', array( 3, 4, 6 ) );`
You should put this code into your `wp-config.php` file so that this plugin can read it.
----
#### Usage ####
This plugin inserts its UI in two places:
1. The "Personal Options" section of the WordPress "Edit User" screen
2. As a block for the Contact Layout Editor extension in CiviCRM
Setting the group memberships of a Contact or User has the same effect in both places.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment