add_existing_user_to_blog() WordPress Function
The add_existing_user_to_blog() function allows you to add an existing user to a blog. This is useful if you want to give someone access to a blog that they do not already have access to.
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
(array|false)(Optional)User details. Must at least contain values for the keys listed below.
- 'user_id'
(int) The ID of the user being added to the current blog. - 'role'
(string) The role to be assigned to the user.
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.
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
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; } }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
MU (3.0.0) | Introduced. |