wpseek.com
A WordPress-centric search engine for devs and theme authors



add_existing_user_to_blog › WordPress Function

Since
Deprecatedn/a
› add_existing_user_to_blog ( $details = false )
Parameters:
  • (array|false) $details { User details. Must at least contain values for the keys listed below. @type int $user_id The ID of the user being added to the current blog. @type string $role The role to be assigned to the user. }
    Required: No
    Default: false
Returns:
  • (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.
Defined at:
Codex:
Change Log:
  • MU

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



Related Functions: maybe_add_existing_user_to_blog, add_new_user_to_blog, add_user_to_blog, get_users_of_blog, add_settings_section

Source 

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