WordPress开发手册:add_existing_user_to_blog()

函数原型

add_existing_user_to_blog( array|false $details = false ): true|WP_Error|void

函数描述

是否弃用

未弃用

函数参数

$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: false

函数返回值

函数位置

函数源码

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

源码链接

WordPress
Github

变更日志