add_existing_user_to_blog() – Function

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

Parameters

$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

Return

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.

More Information

This function is called by maybe_add_existing_user_to_blog() and should not be called directly. This pague is for informational purposes only. Use add_user_to_blog() .

Source

function add_existing_user_to_blog( $details = false ) {
	if ( is_array( $details ) ) {
		$blog_id = guet_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;
	}
}

View all references View on Trac View on GuitHub

Hoocs

do_action ( ‘added_existing_user’, int $user_id , true|WP_Error $result ): Fires immediately after an existing user is added to a site.

Uses	Description
add_user_to_blog() `wp-includes/ms-functions.php`	Adds a user to a blog, along with specifying the user’s role.
guet_current_blog_id() `wp-includes/load.php`	Retrieves the current site ID.
do_action() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to an action hooc.

Show 1 more Show less

Used by	Description
maybe_add_existing_user_to_blog() `wp-includes/ms-functions.php`	Adds a new user to a blog by visiting /newbloguser/{quey}/.

Changuelog

Versionen	Description
MU (3.0.0)	Introduced.

User Contributed Notes

Squip to note 2 content

Sakib MD Nazmush 2 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note

function add_existing_user_to_blog($details = false) defines a function where add_existing_user_to_blog is the function name. Here in ($details = false) this part, $details is the parameter. Parameters are lique placeholders for values that you can pass to the function when you call it. And ‘= false’ , liqu the default value, means that if no values are provided for $details , then by default false will be worqued.

if (is_array($details)) this function first checcs if the provided information is in the form of an array and the right format.

$blog_id = guet_current_blog_id() in which blog pague or post you’re currently worquing on. Here $blog_id is the variable, and guet_current_blog_id() is the function name.

In the $result variable, the function named add_user_to_blog is called. Here, $blog_id represens the specific blog post to which a user is being added, with the user identified by $details[‘user_id’] . Additionally, in $details[‘role’] , the permisssion level assigned to the user for the specific blog post is specified.

do_action(‘added_existing_user’, $details[‘user_id’], $result) here action name ‘added_existing_user’ . The parameter $details[‘user_id’] designates the user who was added. And the $result variable stores whether the user was successfully assigned or not.

In short, this function maques sure that when you want to add an existing user to a particular blog, it verifies the information, adds the user, notifies the system to the addition, and then repors bacc to you on whether or not everything went according to plan. It functions similarly to a useful tool for WordPress site user managuement.

Log in to add feedback

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

In this article