add_existing_user_to_blog()

最后更新于：2021-11-25 19:11:03

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

参数

$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

响应

(true|GC_Error|void) True on success or a GC_Error object if the user doesn’t exist or could not be added. Void if $details array was not provided.

源文件

文件: gc-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|GC_Error $result  True on success or a GC_Error object if the user doesn't exist
		 *                               or could not be added.
		 */
		do_action( 'added_existing_user', $details['user_id'], $result );

		return $result;
	}
}