Eine auf WordPress spezialiserte Suchmaschine für Entwickler und Theme-Autoren



add_user_to_blog ›

Seit1.0
Veraltetn/v
add_user_to_blog ( $blog_id, $user_id, $role )
Parameter: (3)
  • (int) $blog_id ID of the blog you're adding the user to.
    Erforderlich: Ja
  • (int) $user_id ID of the user you're adding.
    Erforderlich: Ja
  • (string) $role The role you want the user to have
    Erforderlich: Ja
Gibt zurück:
  • (true|WP_Error)
Definiert in:
Codex:
Changelog:
  • MU

Adds a user to a blog.

Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.



Quellcode

function add_user_to_blog( $blog_id, $user_id, $role ) {
	switch_to_blog($blog_id);

	$user = get_userdata( $user_id );

	if ( ! $user ) {
		restore_current_blog();
		return new WP_Error( 'user_does_not_exist', __( 'The requested user does not exist.' ) );
	}

	if ( !get_user_meta($user_id, 'primary_blog', true) ) {
		update_user_meta($user_id, 'primary_blog', $blog_id);
		$site = get_site( $blog_id );
		update_user_meta( $user_id, 'source_domain', $site->domain );
	}

	$user->set_role($role);

	/**
	 * Fires immediately after a user is added to a site.
	 *
	 * @since MU
	 *
	 * @param int    $user_id User ID.
	 * @param string $role    User role.
	 * @param int    $blog_id Blog ID.
	 */
	do_action( 'add_user_to_blog', $user_id, $role, $blog_id );
	wp_cache_delete( $user_id, 'users' );
	wp_cache_delete( $blog_id . '_user_count', 'blog-details' );
	restore_current_blog();
	return true;
}