wpmu_validate_blog_signup( string $blogname, string $blog_title, WP_User|string $user = '' ): array

Description

Parameters

$blognamestring

The site name provided by the user. Must be unique.

$blog_titlestring

The site title provided by the user.

$userWP_User|stringoptional

The user object to check against the new site name. Default empty string.Default: ''

Return

array

Array of domain, path, site name, site title, user and error messages.

• $domainstring

  Domain for the site.

• $pathstring

  Path for the site. Used in subdirectory installations.

• $blognamestring

  The unique site name (slug).

• $blog_titlestring

  Blog title.

• $userstring|WP_User

  By default, an empty string. A user object if provided.

• $errorsWP_Error

  WP_Error containing any errors found.

Hooks fired · 3

3 hooks fire while wpmu_validate_blog_signup() runs, in this order:

1. 1
   apply_filters( minimum_site_name_length )filterline 681 (+43 into the body)

   Filters the minimum site name length required when validating a site signup.

2. 2
   apply_filters( newblogname )filterline 708 (+70 into the body)

   Filters the new site name during registration.

3. 3
   apply_filters( wpmu_validate_blog_signup )filterline 784 (+146 into the body)

   Filters site details and error messages following registration.

Uses · 14

• get_network()Retrieves network data given a network ID or network object.
• 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.
• is_subdomain_install()Whether a subdomain configuration is enabled.
• get_subdirectory_reserved_names()Retrieves a list of reserved site on a sub-directory Multisite installation.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• _n()Translates and retrieves the singular or plural form based on the supplied number.
• number_format_i18n()Converts float number to format based on the locale.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• domain_exists()Checks whether a site name is already taken.
• username_exists()Determines whether the given username exists.

Used by · 2

• validate_blog_form()Validates the new site sign-up.
• validate_blog_signup()Validates new site signup.

Source

View on Trac ↗View on GitHub ↗

638function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {639	global $wpdb, $domain;640 641	$current_network = get_network();642	$base            = $current_network->path;643 644	$blog_title = strip_tags( $blog_title );645 646	$errors        = new WP_Error();647	$illegal_names = get_site_option( 'illegal_names' );648 649	if ( ! is_array( $illegal_names ) ) {650		$illegal_names = array( 'www', 'web', 'root', 'admin', 'main', 'invite', 'administrator' );651		add_site_option( 'illegal_names', $illegal_names );652	}653 654	/*655	 * On sub dir installations, some names are so illegal, only a filter can656	 * spring them from jail.657	 */658	if ( ! is_subdomain_install() ) {659		$illegal_names = array_merge( $illegal_names, get_subdirectory_reserved_names() );660	}661 662	if ( empty( $blogname ) ) {663		$errors->add( 'blogname', __( 'Please enter a site name.' ) );664	}665 666	if ( preg_match( '/[^a-z0-9]+/', $blogname ) ) {667		$errors->add( 'blogname', __( 'Site names can only contain lowercase letters (a-z) and numbers.' ) );668	}669 670	if ( in_array( $blogname, $illegal_names, true ) ) {671		$errors->add( 'blogname', __( 'That name is not allowed.' ) );672	}673 674	/**675	 * Filters the minimum site name length required when validating a site signup.676	 *677	 * @since 4.8.0678	 *679	 * @param int $length The minimum site name length. Default 4.680	 */681	$minimum_site_name_length = apply_filters( 'minimum_site_name_length', 4 );682 683	if ( strlen( $blogname ) < $minimum_site_name_length ) {684		/* translators: %s: Minimum site name length. */685		$errors->add( 'blogname', sprintf( _n( 'Site name must be at least %s character.', 'Site name must be at least %s characters.', $minimum_site_name_length ), number_format_i18n( $minimum_site_name_length ) ) );686	}687 688	// Do not allow users to create a site that conflicts with a page on the main blog.689	if ( ! is_subdomain_install() && $wpdb->get_var( $wpdb->prepare( 'SELECT post_name FROM ' . $wpdb->get_blog_prefix( $current_network->site_id ) . "posts WHERE post_type = 'page' AND post_name = %s", $blogname ) ) ) {690		$errors->add( 'blogname', __( 'Sorry, you may not use that site name.' ) );691	}692 693	// All numeric?694	if ( preg_match( '/^[0-9]*$/', $blogname ) ) {695		$errors->add( 'blogname', __( 'Sorry, site names must have letters too!' ) );696	}697 698	/**699	 * Filters the new site name during registration.700	 *701	 * The name is the site's subdomain or the site's subdirectory702	 * path depending on the network settings.703	 *704	 * @since MU (3.0.0)705	 *706	 * @param string $blogname Site name.707	 */708	$blogname = apply_filters( 'newblogname', $blogname );709 710	$blog_title = wp_unslash( $blog_title );711 712	if ( empty( $blog_title ) ) {713		$errors->add( 'blog_title', __( 'Please enter a site title.' ) );714	}715 716	// Check if the domain/path has been used already.717	if ( is_subdomain_install() ) {

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.