wpmu_create_user() WordPress Function
The wpmu_create_user() function is used to create a new user in a WordPress Multisite installation. This function is only available in WordPress Multisite.
wpmu_create_user( string $user_name, string $password, string $email ) #
Creates a user.
Description
This function runs when a user self-registers as well as when a Super Admin creates a new user. Hook to ‘wpmu_new_user’ for events that should affect all new users, but only on Multisite (otherwise use ‘user_register’).
Parameters
- $user_name
(string)(Required)The new user's login name.
- $password
(string)(Required)The new user's password.
(string)(Required)The new user's email address.
Return
(int|false) Returns false on failure, or int $user_id on success
Source
File: wp-includes/ms-functions.php
function wpmu_create_user( $user_name, $password, $email ) { $user_name = preg_replace( '/\s+/', '', sanitize_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, 'capabilities' ); 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; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
MU (3.0.0) | Introduced. |