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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$detailsarray|falseoptional

User details. Must at least contain values for the keys listed below.Default: false

• $user_idint

  The ID of the user being added to the current blog.

• $rolestring

  The role to be assigned to the user.

Return value

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.

Performance profile

How much work a call to add_existing_user_to_blog() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Only touches the object cache, via wp_cache_delete().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

4–24

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 25.

Plugin surface

1 hook

Third-party callbacks on 'added_existing_user' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()called directly
• cacheobject cachewp_cache_delete()one call below add_existing_user_to_blog()

Further down the call graph this can also reach query, serialize, option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost add_existing_user_to_blog() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while add_existing_user_to_blog() runs, in this order:

1. 1
   do_action( added_existing_user )actionline 2289 (+14 into the body)

   Fires immediately after an existing user is added to a site.

Uses · 3

• get_current_blog_id()Retrieves the current site ID.
• add_user_to_blog()Adds a user to a blog, along with specifying the user's role.
• do_action()Calls the callback functions that have been added to an action hook.

Used by · 1

• maybe_add_existing_user_to_blog()Adds a new user to a blog by visiting /newbloguser/{key}/.

Source code

View on Trac ↗View on GitHub ↗

2275function add_existing_user_to_blog( $details = false ) {2276	if ( is_array( $details ) ) {2277		$blog_id = get_current_blog_id();2278		$result  = add_user_to_blog( $blog_id, $details['user_id'], $details['role'] );2279 2280		/**2281		 * Fires immediately after an existing user is added to a site.2282		 *2283		 * @since MU (3.0.0)2284		 *2285		 * @param int           $user_id User ID.2286		 * @param true|WP_Error $result  True on success or a WP_Error object if the user doesn't exist2287		 *                               or could not be added.2288		 */2289		do_action( 'added_existing_user', $details['user_id'], $result );2290 2291		return $result;2292	}2293}

Changelog

Introduced in MU (3.0.0). One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/ms-functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.