W3cubDocs

/WordPress

add_new_user_to_blog( int $user_id, string $password, array $meta )

Adds a newly created user to the appropriate blog

Description

To add a user in general, use add_user_to_blog(). This function is specifically hooked into the ‘wpmu_activate_user’ action.

See also

Parameters

$user_id

(int) (Required) User ID.

$password

(string) (Required) User password. Ignored.

$meta

(array) (Required) Signup meta data.

Source

File: wp-includes/ms-functions.php 

function add_new_user_to_blog( $user_id, $password, $meta ) {
	if ( ! empty( $meta['add_to_blog'] ) ) {
		$blog_id = $meta['add_to_blog'];
		$role    = $meta['new_role'];
		remove_user_from_blog( $user_id, get_network()->site_id ); // Remove user from main blog.

		$result = add_user_to_blog( $blog_id, $user_id, $role );

		if ( ! is_wp_error( $result ) ) {
			update_user_meta( $user_id, 'primary_blog', $blog_id );
		}
	}
}

Uses

Uses Description
wp-includes/ms-network.php: get_network()

Retrieves network data given a network ID or network object.
wp-includes/user.php: update_user_meta()

Update user meta field based on user ID.
wp-includes/ms-functions.php: remove_user_from_blog()

Remove a user from a blog.
wp-includes/ms-functions.php: add_user_to_blog()

Adds a user to a blog, along with specifying the user’s role.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Changelog

Version Description
MU (3.0.0) Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_new_user_to_blog