How to use add_user_to_blog filter in WordPress

add_user_to_blog filter

Fires immediately after a user is added to a site.

To use add_user_to_blog filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function modify_add_user_to_blog_defaults which takes 3 parameters and we registered using add_filter. The first parameter add_user_to_blog is the name of the hook, The second parameter modify_add_user_to_blog_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove add_user_to_blog filter.

Parameters

Below are the 3 parameters required to use this hook.

• $user_id : (int) User ID.
• $role : (string) User role.
• $blog_id : (int) Blog ID.

Live Example 1

Below is an example of how you can use this hook.

	function weplugins_modify_add_user_to_blog_defaults($user_id, $role, $blog_id) {
		// Update the $user_id variable according to your website requirements and return this variable. You can modify the $user_id variable conditionally too if you want.
		return $user_id;
	}
	// add the filter
	add_filter("add_user_to_blog", "weplugins_modify_add_user_to_blog_defaults", 10, 3);
	

Live Example 2

To remove a hook callback, use the example below.

	remove_filter("add_user_to_blog", "weplugins_modify_add_user_to_blog_defaults", 10, 3);
	

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Live Example 3

Adding a user to multiple network sites:

	function weplugins_add_user_to_network_sites($user_id) {
		// Put common sites here
		$blogs = array(1, 2, 3, 5, 8);
		foreach ($blogs as $blog_id) {
			add_user_to_blog($blog_id, $user_id, 'subscriber');
		}
	}
	

Contact Us

If you’re having any trouble using this hook or need customization, please contact us and we’d be happy to assist you.