add_existing_user_to_blog( array|false $details = false ): true|WP_Error|void
Adds a user to a blog based on details from maybe_add_existing_user_to_blog() .
Contents
Parameters
-
$detailsarray|false Optional -
User details. Must at least contain values for the keys listed below.
user_idintThe ID of the user being added to the current blog.rolestringThe role to be assigned to the user.
Default:
false
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.
More Information
This function is called by maybe_add_existing_user_to_blog() and should not be called directly. This page is for informational purposes only. Use add_user_to_blog().
Source
File: wp-includes/ms-functions.php.
View all references
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 MU (3.0.0)
*
* @param int $user_id User ID.
* @param true|WP_Error $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;
}
}
Hooks
-
do_action( 'added_existing_user',
int $user_id ,true|WP_Error $result ) -
Fires immediately after an existing user is added to a site.
Changelog
| Version | Description |
|---|---|
| MU (3.0.0) | Introduced. |