The plugin synchronizes users with a main site, allowing you to access all sites where the plugin is installed with the same credentials.<\/p>\n\n
If the user exists on the client, but not on the server, the plugin blocks access by changing the password to the user saved on the client.<\/p><\/li>\n
For security reasons the plugin does not synchronize administrators.<\/p><\/li>\n
Communications take place via APIs protected through an encrypted token system. Usernames and passwords are never passed in clear text or through a basic authentication system.<\/p>\n\n
Synchronizing administrators is not allowed, administrators must be managed locally.<\/p>\n\n
Some user metadata is not passed because it is specific to the configuration of each individual site.<\/p>\n\n
All operations are logged both on the client site and on the server.<\/p>\n\n
By default the plugin synchronizes all user except administrators. By default The plugin synchronizes all user data, roles, and metadata.<\/p>\n\n
However, you can customize who and what to sync through many specially created filters and hooks.<\/p>\n\n
First you may want to choose which users you want to sync and which you don't. You can choose which user roles you want to sync. This way if the user has a certain role it will be synchronized, otherwise not. You can do this through the sucw-roles-exclude-all-sync-except filter placed in the client site.<\/p>\n\n
apply_filters('sucw-roles-exclude-all-sync-except', ['subscriber']);<\/strong>\n(CLIENT)<\/em> Excludes all roles from synchronization except those specified\nThis overrides the filter 'sucw-roles-to-exclude-sync'!\nparam array $array_exclude the list of default roles ['subscriber']\nsince 1.0.0<\/p>\n\n Otherwise you can choose to sync all users except those who have a certain role.<\/p>\n\n apply_filters('sucw-roles-to-exclude-sync', ['administrator'])<\/strong>\n(CLIENT)<\/em> These are the roles that do not need to synchronize\nIf active The filter 'sucw-roles-exclude-all-sync-except' will be ignored\nparam array $array_exclude the list of default roles ['administrator']\nsince 1.0.0<\/p>\n\n The same role configuration entered in the client sites should be placed in the server site.<\/p>\n\n add_filter('sucw-roles-exclude-all-sync-except', []);<\/strong>\n(SERVER)<\/em> Exclude all roles from synchronization except those specified\nIf active the 'sucw-block-user-roles' filter will be ignored\nparam array $array_exclude the list of default roles []\nsince 1.0.0<\/p>\n\n add_filter('sucw-block-user-roles', ['administrator']);<\/strong>\n(SERVER)<\/em> If the user has one of the blocked roles I won't let them through\nvar array $block_user_roles\nreturn array\nsince 1.0.0<\/p>\n\n apply_filters('sucw-update-roles', $roles)<\/strong>\n(CLIENT)<\/em> The list of roles to save in the user profile when creating or updating the user. if it is an empty array it does not update the roles.\nsince 1.0.0<\/p>\n\n do_action( 'sucw-update-user', $user_id, $user_data )<\/strong>\n(CLIENT)<\/em> It is called after updating or creating a user\nparam: int $user_id the user id\nobject $user_data user data\nsince 1.0.0<\/p>\n\n apply_filters('sucw-remote-args', $args)<\/strong>\n(CLIENT)<\/em> These are the arguments for the client to call the server\nparam array $args Default ['method':'POST', 'timeout':$timeout, 'redirection':2, 'httpversion':'1.0', 'blocking':true, 'headers':$headers, 'cookies':[]]\nsince 1.0.0<\/p>\n\n apply_filters('sucw-remote-timeout', 15)<\/strong>\n(CLIENT)<\/em> The server call times out\nparam int $timeout Default 15\nsince 1.0.0<\/p>\n\n apply_filters('sucw-allow-metadata', true)<\/strong>\n(CLIENT)<\/em> Allows you to update metadata\nparam bool $allow_metadata Allows you to update metadata\nif false it does not update the metadata, if it is an array it only updates the metadata present in the array\nsince 1.0.0<\/p>\n\n apply_filters('sucw_register_url', $url)<\/strong>\n(CLIENT)<\/em> Manages the registration link\nparam string $url il link di default\nsince 1.0.0<\/p>\n\n apply_filters('sucw-lostpassword-url', url)<\/strong>\n(CLIENT)<\/em> Manages lost password link\nparam string $url il link di default\nsince 1.0.0<\/p>\n\n apply_filters( 'sucw-htaccess', true )<\/strong>\n(CLIENT)<\/em> If the server uses htaccess or you need to make the call to the API via \/?rest_route (false)\nsince 1.0.0<\/p>\n\n apply_filters('sucw-api-response', $response, 'login|check-user')<\/strong>\n(SERVER)<\/em> The server's response to the login client api call\nparam array $response ['response_status'=>'ok', 'user'=>$user] | ['response_status'=>'error', 'message'=>'...']\nparam string $type login | check-user\nsince 1.0.0<\/p>\n\n apply_filters('sucw-log-limit', 1000)<\/strong>\n(SERVER & CLIENT) The number of logs to keep on both server and client\nparam int $log_limit Default 1000\nsince 1.0.0<\/p>\n\n If the user misspells the password, it may appear as an error message that the user does not exist. To make the error messages more generic you can use the following code:<\/p>\n\n To add a new role you need to create code like this on both the client and server sites<\/p>\n\nBelow are the other filters and hooks you can use to customize your plugin configuration.<\/h3>\n\n
TIPS & TRICKS<\/h3>\n\n
add_filter('login_errors', 'login_message', 10, 1);\nfunction login_message($error ) {\n if ($error != '') {\n $error = \"Incorrect username or password\";\n }\n return $error;\n}\n<\/code><\/pre>\n\nadd_role('my_custom_role', \n __( 'My Custom Role' ), \n array( 'read' => true, 'read_private_posts' => true, )\n);\n<\/code><\/pre>\n\nCredits<\/h3>\n\n