wpmu_validate_user_signup( string $user_name, string $user_email ): array

Description

Parameters

$user_namestring

The login name provided by the user.

$user_emailstring

The email provided by the user.

Return

array

The array of user name, email, and the error messages.

• $user_namestring

  Sanitized and unique username.

• $orig_usernamestring

  Original username.

• $user_emailstring

  User email address.

• $errorsWP_Error

  WP_Error object containing any errors found.

Hooks fired · 2

2 hooks fire while wpmu_validate_user_signup() runs, in this order:

1. 1
   apply_filters( illegal_user_logins )filterline 499 (+31 into the body)

   Filters the list of disallowed usernames.

2. 2
   apply_filters( wpmu_validate_user_signup )filterline 601 (+133 into the body)

   Filters the validated user registration details.

Uses · 13

• sanitize_user()Sanitizes a username, stripping out unsafe characters.
• __()Retrieves the translation of $text.
• sanitize_email()Strips out all characters that are not allowable in an email.
• get_site_option()Retrieve an option value for the current network based on name of option.
• add_site_option()Adds a new option for the current network.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_email()Verifies that an email is valid.
• is_email_address_unsafe()Checks an email address against a list of banned domains.
• username_exists()Determines whether the given username exists.
• email_exists()Determines whether the given email exists.
• wp_login_url()Retrieves the login URL.
• mysql2date()Converts given MySQL date string into a different format.

Used by · 3

• WP_REST_Users_Controller::create_item()Creates a single user.
• validate_blog_signup()Validates new site signup.
• validate_user_form()Validates user sign-up name and email.

Source

View on Trac ↗View on GitHub ↗

468function wpmu_validate_user_signup( $user_name, $user_email ) {469	global $wpdb;470 471	$errors = new WP_Error();472 473	$orig_username = $user_name;474	$user_name     = preg_replace( '/\s+/', '', sanitize_user( $user_name, true ) );475 476	if ( $user_name !== $orig_username || preg_match( '/[^a-z0-9]/', $user_name ) ) {477		$errors->add( 'user_name', __( 'Usernames can only contain lowercase letters (a-z) and numbers.' ) );478		$user_name = $orig_username;479	}480 481	$user_email = sanitize_email( $user_email );482 483	if ( empty( $user_name ) ) {484		$errors->add( 'user_name', __( 'Please enter a username.' ) );485	}486 487	$illegal_names = get_site_option( 'illegal_names' );488 489	if ( ! is_array( $illegal_names ) ) {490		$illegal_names = array( 'www', 'web', 'root', 'admin', 'main', 'invite', 'administrator' );491		add_site_option( 'illegal_names', $illegal_names );492	}493 494	if ( in_array( $user_name, $illegal_names, true ) ) {495		$errors->add( 'user_name', __( 'Sorry, that username is not allowed.' ) );496	}497 498	/** This filter is documented in wp-includes/user.php */499	$illegal_logins = (array) apply_filters( 'illegal_user_logins', array() );500 501	if ( in_array( strtolower( $user_name ), array_map( 'strtolower', $illegal_logins ), true ) ) {502		$errors->add( 'user_name', __( 'Sorry, that username is not allowed.' ) );503	}504 505	if ( ! is_email( $user_email ) ) {506		$errors->add( 'user_email', __( 'Please enter a valid email address.' ) );507	} elseif ( is_email_address_unsafe( $user_email ) ) {508		$errors->add( 'user_email', __( 'You cannot use that email address to signup. There are problems with them blocking some emails from WordPress. Please use another email provider.' ) );509	}510 511	if ( strlen( $user_name ) < 4 ) {512		$errors->add( 'user_name', __( 'Username must be at least 4 characters.' ) );513	}514 515	if ( strlen( $user_name ) > 60 ) {516		$errors->add( 'user_name', __( 'Username may not be longer than 60 characters.' ) );517	}518 519	// All numeric?520	if ( preg_match( '/^[0-9]*$/', $user_name ) ) {521		$errors->add( 'user_name', __( 'Sorry, usernames must have letters too!' ) );522	}523 524	$limited_email_domains = get_site_option( 'limited_email_domains' );525 526	if ( is_array( $limited_email_domains ) && ! empty( $limited_email_domains ) ) {527		$limited_email_domains = array_map( 'strtolower', $limited_email_domains );528		$email_domain          = strtolower( substr( $user_email, 1 + strpos( $user_email, '@' ) ) );529 530		if ( ! in_array( $email_domain, $limited_email_domains, true ) ) {531			$errors->add( 'user_email', __( 'Sorry, that email address is not allowed!' ) );532		}533	}534 535	// Check if the username has been used already.536	if ( username_exists( $user_name ) ) {537		$errors->add( 'user_name', __( 'Sorry, that username already exists!' ) );538	}539 540	// Check if the email address has been used already.541	if ( email_exists( $user_email ) ) {542		$errors->add(543			'user_email',544			sprintf(545				/* translators: %s: Link to the login page. */546				__( '<strong>Error:</strong> This email address is already registered. <a href="%s">Log in</a> with this address or choose another one.' ),547				wp_login_url()

History

Introduced in MU (3.0.0). Unchanged from 6.7.7 through 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.