Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use add_user_to_blog filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
July 12, 2022
5 minutes read

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 Flipper Code, 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 name of the hook, The second parameter modify_add_user_to_blog_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

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


    Below are the 3 parameters are required to use this hook.

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

Live Example

 * Add a user to network sites.
 * @param int $user_id User ID.
function wpdocs_add_user_to_network_sites( $user_id ) {
     // Put common sites here
    $blogs = array( 1, 2, 3, 5,8 ); 

Below is an example how you can use this hook.

                        function 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", "modify_add_user_to_blog_defaults", 10, 3 );

To remove a hook callback, use the example below.

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

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.