W3cubDocs

/WordPress

maybe_add_existing_user_to_blog()

Add a new user to a blog by visiting /newbloguser/{key}/.

Description

This will only work when the user’s details are saved as an option keyed as ‘new_user_{key}’, where ‘{key}’ is a hash generated for the user to be added, as when a user is invited through the regular WP Add User interface.

Source

File: wp-includes/ms-functions.php 

function maybe_add_existing_user_to_blog() {
	if ( false === strpos( $_SERVER['REQUEST_URI'], '/newbloguser/' ) ) {
		return;
	}

	$parts = explode( '/', $_SERVER['REQUEST_URI'] );
	$key   = array_pop( $parts );

	if ( '' === $key ) {
		$key = array_pop( $parts );
	}

	$details = get_option( 'new_user_' . $key );
	if ( ! empty( $details ) ) {
		delete_option( 'new_user_' . $key );
	}

	if ( empty( $details ) || is_wp_error( add_existing_user_to_blog( $details ) ) ) {
		wp_die(
			sprintf(
				/* translators: %s: Home URL. */
				__( 'An error occurred adding you to this site. Back to the <a href="%s">homepage</a>.' ),
				home_url()
			)
		);
	}

	wp_die(
		sprintf(
			/* translators: 1: Home URL, 2: Admin URL. */
			__( 'You have been added to this site. Please visit the <a href="%1$s">homepage</a> or <a href="%2$s">log in</a> using your username and password.' ),
			home_url(),
			admin_url()
		),
		__( 'WordPress &rsaquo; Success' ),
		array( 'response' => 200 )
	);
}

Uses

Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/functions.php: wp_die()

Kills WordPress execution and displays HTML page with an error message.
wp-includes/link-template.php: admin_url()

Retrieves the URL to the admin area for the current site.
wp-includes/link-template.php: home_url()

Retrieves the URL for the current site where the front end is accessible.
wp-includes/option.php: delete_option()

Removes option by name. Prevents removal of protected WordPress options.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/ms-functions.php: add_existing_user_to_blog()

Add a user to a blog based on details from maybe_add_existing_user_to_blog().
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Changelog

Version Description
MU (3.0.0) Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/maybe_add_existing_user_to_blog