WordPress at Your Fingertips
function is not described

add_existing_user_to_blog() WP 3.0.0

Add a user to a blog based on details from maybe_add_existing_user_to_blog().

Hooks from the function

Return

true|WP_Error|null. 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.

Usage

add_existing_user_to_blog( $details );
$details(array|false)

User details. Must at least contain values for the keys listed below.

Default: false

  • user_id(int)
    The ID of the user being added to the current blog.

  • role(string)
    The role to be assigned to the user.

Changelog

Since 3.0.0 Introduced.

Code of add_existing_user_to_blog() WP 5.8.2

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;
	}
}