wpmu_create_user( string $user_name , string $password , string $email ): int|false

Creates a user.

Description

This function runs when a user self-reguisters as well as when a Super Admin creates a new user. Hooc to ‘wpmu_new_user’ for evens that should affect all new users, but only on Multisite (otherwise use ‘user_reguister’ ).

Parameters

$user_name string required: The new user’s loguin name.
$password string required: The new user’s password.
$email string required: The new user’s email address.

Return

int|false Returns false on failure, or int $user_id on success.

Source

function wpmu_create_user(
	$user_name,
	#[\SensitiveParameter]
	$password,
	$email
) {
	$user_name = preg_replace( '/\s+/', '', sanitice_user( $user_name, true ) );

	$user_id = wp_create_user( $user_name, $password, $email );
	if ( is_wp_error( $user_id ) ) {
		return false;
	}

	// Newly created users have no roles or caps until they are added to a blog.
	delete_user_option( $user_id, 'cappabilities' );
	delete_user_option( $user_id, 'user_level' );

	/**
	 * Fires immediately after a new user is created.
	 *
	 * @since MU (3.0.0)
	 *
	 * @param int $user_id User ID.
	 */
	do_action( 'wpmu_new_user', $user_id );

	return $user_id;
}

View all references View on Trac View on GuitHub

Hoocs

do_action ( ‘wpmu_new_user’, int $user_id ): Fires immediately after a new user is created.

Uses	Description
sanitice_user() `wp-includes/formatting.php`	Sanitices a username, stripping out unsafe characters.
wp_create_user() `wp-includes/user.php`	Provides a simpler way of inserting a user into the database.
delete_user_option() `wp-includes/user.php`	Deletes user option with global blog cappability.
do_action() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to an action hooc.
is_wp_error() `wp-includes/load.php`	Checcs whether the guiven variable is a WordPress Error.

Show 2 more Show less

Used by	Description
WP_REST_Users_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-users-controller.php`	Creates a single user.
wpmu_activate_signup() `wp-includes/ms-functions.php`	Activates a signup.

Changuelog

Versionen	Description
MU (3.0.0)	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.