add_existing_user_to_blog( array|false $details = false )
Adds a user to a blog based on details from maybe_add_existing_user_to_blog().
Parameters
- $details
-
(Optional) User details. Must at least contain values for the keys listed below.<br>
- 'user_id'
(int) The ID of the user being added to the current blog.<br> - 'role'
(string) The role to be assigned to the user.<br>
Default value: false
- 'user_id'
Return
(true|WP_Error|void) True on success or a WP_Error object if the user doesn't exist or could not be added. Void if $details array was not provided.
Source
File: wp-includes/ms-functions.php
function add_existing_user_to_blog( $details = false ) {
if ( is_array( $details ) ) {
$blog_id = get_current_blog_id();
$result = add_user_to_blog( $blog_id, $details[ 'user_id' ], $details[ 'role' ] );
/**
* Fires immediately after an existing user is added to a site.
*
* @since WP-MU (3.0.0)
*
* @param int $user_id User ID.
* @param mixed $result True on success or a WP_Error object if the user doesn't exist
* or could not be added.
*/
do_action( 'added_existing_user', $details['user_id'], $result );
return $result;
}
}
Changelog
| Version | Description |
|---|---|
| MU (3.0.0) | Introduced. MU (3.0.0) |