add_user_to_blog

Fires immediately after a user is added to a site.

Description

do_action( 'add_user_to_blog', (int) $user_id, (string) $role, (int) $blog_id ); 

Parameters (3)

0. $user_id (int)
The user id.
1. $role (string)
User role.
2. $blog_id (int)
The blog id.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'add_user_to_blog', $user_id, $role, $blog_id ); 
The following example is for adding a hook callback.
  1. // define the add_user_to_blog callback 
  2. function action_add_user_to_blog( $user_id, $role, $blog_id ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'add_user_to_blog', 'action_add_user_to_blog', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'add_user_to_blog', 'action_add_user_to_blog', 10, 3 ); 

Defined (1)

The action is defined in the following location(s).

/wp-includes/ms-functions.php  
  1. do_action( 'add_user_to_blog', $user_id, $role, $blog_id );