WPM User Sync – WordPress Plugin
Hello and Welcome! ‘WPM User Sync’ (which actually means “WordPress Multi-Site User Synchronization”) is a plugin that allow you to configure & automate users sync between wordpress sites when you are using a multi-site setup. You will find options at network & sites level, to take control when: a new user is created, a new site is created, and when we change a role for an existing user.
WPM User Sync history
In March 2020, I started a new project with Ivana Tilca called “ConoSur.tech“. This project has a website, that is a WordPress multisite instance with several microsites inside. It uses SUBDOMAIN_INSTALL method, that means “each site on your network will be a subdomain”.
One of the most important requirements was: we MUST give to our registered users single-sign on experience to all present and future microsites. Here we find a big problem: WordPress out-of-the-box experience do not sync users between sites (neither for existing nor for future).
After search some plugins in WordPress directory, we found a few of them with very high prices. For this reason, I decided start a new solution development to solve this problem by myself. Here you have WPM User Sync :-).
Can I contribute?
Yes! Just fork this repo, improve the code & send a PR to review 🙂 Repo: https://github.com/pablodiloreto/wpm-user-sync
If you want propose a new feature, or report a bug -> https://github.com/pablodiloreto/wpm-user-sync/issues
The normal plugin install process applies, that is search for ‘WPM User Sync’ from your plugin screen or via the manual method:
- Upload the ‘WPM User Sync’ folder into your ‘/wp-content/plugins/’ directory.
- Activate the plugin through the ‘Plugins’ menu in WordPress.
That’s it! ‘WPM User Sync’ will appear in your dashboard at Network & Site level.
Frequently Asked Questions
Is this plugin in the WordPress Plugin directory?
Yes! In this URL -> https://wordpress.org/plugins/wpm-user-sync/
What exactly does this plugin do?
WPM User Sync is a plugin that enable the user synchronization in your WordPress Multisite, that is a type of WordPress installation that allows you to create and manage a network of multiple websites from a single WordPress dashboard. Key concepts:
- WPM User sync is a plugin, not a core feature of WordPress. It was built by external developers to WordPress. However, it goes through a detailed testing process to ensure smooth operation as it interacts with core aspects of the CMS.
- In out-of-the-box WordPress multisite setup, when you create a new user, it never sync to other sites in your network. Also, when you create a new site in your network, no users are synced to this new site. This means that you must manually register or associate users to your site, or your new site with your users. This is a tedious and manual process.
- This plugin bring you the possibility tu automate all this scenarios: a) when you create a new user, this user can be synced to all existing sites in your network; b) when you create a new site, all users can be automatic synced to it; c) when we change an user role in one site, you can configure to replicate this change to all sites in your network; d) if you do not want automation, with this plugin you can do all previous things in manual mode :-).
- Last but not least, when we talk about ‘user synchronization’, we never duplicate user data. The user is only one, and the same identity is the one that is added to the sites in a reference model. If you are using “SUBDOMAIN_INSTALL” option (that is, each site on your network will be a subdomain) and you want “single-sign on experience”, you should configure some cookies aspects in your WP-CONFIG. Check plugin’s website help for more information.
In WPM User Sync you will can configure some triggers to automate user sync. A trigger is procedural code that is automatically executed in response to certain events, and in the particular case of WPM User Sync & WordPress, to one of the following events:
- New user creation: when an user register in your site, or an admin create a new one.
- New site creation: when an admin or authorized user create a new site in your network.
- User role edited in one site: when you edit a user role in one of your network sites.
Its very important to remember that you can configure all these 3 triggers from network level options.
At network level you can configure the 3 triggers that we descripted in the past:
- New Site Automatic Sync: When a new site is created in the network, all users in the database will be added to this new site with default site role. If no default role is configured, “subscriber” role will be added.
- New User Automatic Sync: When a new user is created in the network, will be added to all sites in the database with each default site role. If no default role is configured, “subscriber” role will be added.
- Set User Role Automatic Sync: When an user role change is detected in any site (for example change an user to administrator of an specific site) this change will be replicated to all other sites (in the other sites will be administrator, too).
Also, you can execute the following actions:
- Sync from scratch: Sync all sites with all users. Each site will receive all users with default site role. If no default role is configured, “subscriber” role will be added. Existing users will have not changes.
- Sync specific site: All selected sites will receive all users with default site role. If no default role is configured, “subscriber” role will be added. Existing users will have not changes.
At site level you can not configure any option. But you can execute the following action:
- Sync from scratch: Add all network users in your site with default site role. If no default role is configured, “subscriber” role will be added. Existing users will have not changes.
Yes! You can. Disable all triggers at network level & you will allow to execute only manual actions.
Yes. This plugin host information in “sitemeta” table to remember network sync options.