Validates data for a site prior to inserting or updating in the database.

$errors WP_Error Required

Error object, passed by reference. Will contain validation errors if any occurred.

$data array Required

Associative array of complete site data. See wp_insert_site() for the included data.

More Arguments from wp_insert_site( ... $data )

Data for the new site that should be inserted.

• domainstring
  Site domain. Default empty string.
• pathstring
  Site path. Default '/'.
• network_idint
  The site's network ID. Default is the current network ID.
• registeredstring
  When the site was registered, in SQL datetime format. Default is the current time.
• last_updatedstring
  When the site was last updated, in SQL datetime format. Default is the value of $registered.
• publicint
  Whether the site is public. Default 1.
• archivedint
  Whether the site is archived. Default 0.
• matureint
  Whether the site is mature. Default 0.
• spamint
  Whether the site is spam. Default 0.
• deletedint
  Whether the site is deleted. Default 0.
• lang_idint
  The site's language ID. Currently unused. Default 0.
• user_idint
  User ID for the site administrator. Passed to the wp_initialize_site hook.
• titlestring
  Site title. Default is 'Site %d' where %d is the site ID. Passed to the wp_initialize_site hook.
• optionsarray
  Custom option $key => $value pairs to use. Default empty array. Passed to the wp_initialize_site hook.
• metaarray
  Custom site metadata $key => $value pairs to use. Default empty array.
  Passed to the wp_initialize_site hook.

$old_site WP_Site|null Optional

The old site object if the data belongs to a site being updated, or null if it is a new site being inserted.

Default: null

File: wp-includes/ms-site.php. View all references

function wp_validate_site_data( $errors, $data, $old_site = null ) {
	// A domain must always be present.
	if ( empty( $data['domain'] ) ) {
		$errors->add( 'site_empty_domain', __( 'Site domain must not be empty.' ) );
	}

	// A path must always be present.
	if ( empty( $data['path'] ) ) {
		$errors->add( 'site_empty_path', __( 'Site path must not be empty.' ) );
	}

	// A network ID must always be present.
	if ( empty( $data['network_id'] ) ) {
		$errors->add( 'site_empty_network_id', __( 'Site network ID must be provided.' ) );
	}

	// Both registration and last updated dates must always be present and valid.
	$date_fields = array( 'registered', 'last_updated' );
	foreach ( $date_fields as $date_field ) {
		if ( empty( $data[ $date_field ] ) ) {
			$errors->add( 'site_empty_' . $date_field, __( 'Both registration and last updated dates must be provided.' ) );
			break;
		}

		// Allow '0000-00-00 00:00:00', although it be stripped out at this point.
		if ( '0000-00-00 00:00:00' !== $data[ $date_field ] ) {
			$month      = substr( $data[ $date_field ], 5, 2 );
			$day        = substr( $data[ $date_field ], 8, 2 );
			$year       = substr( $data[ $date_field ], 0, 4 );
			$valid_date = wp_checkdate( $month, $day, $year, $data[ $date_field ] );
			if ( ! $valid_date ) {
				$errors->add( 'site_invalid_' . $date_field, __( 'Both registration and last updated dates must be valid dates.' ) );
				break;
			}
		}
	}

	if ( ! empty( $errors->errors ) ) {
		return;
	}

	// If a new site, or domain/path/network ID have changed, ensure uniqueness.
	if ( ! $old_site
		|| $data['domain'] !== $old_site->domain
		|| $data['path'] !== $old_site->path
		|| $data['network_id'] !== $old_site->network_id
	) {
		if ( domain_exists( $data['domain'], $data['path'], $data['network_id'] ) ) {
			$errors->add( 'site_taken', __( 'Sorry, that site already exists!' ) );
		}
	}
}