populate_network( int $network_id = 1, string $domain = '', string $email = '', string $site_name = '', string $path = '/', bool $subdomain_install = false ): true|WP_Error

Parameters

$network_idintoptional

ID of network to populate.Default: 1

$domainstringoptional

The domain name for the network. Example: "example.com".Default: ''

$emailstringoptional

Email address for the network administrator.Default: ''

$site_namestringoptional

The name of the network.Default: ''

$pathstringoptional

The path to append to the network's domain name. Default '/'.Default: '/'

$subdomain_installbooloptional

Whether the network is a subdomain installation or a subdirectory installation. Default false, meaning the network is a subdirectory installation.Default: false

Return

true|WP_Error

True on success, or WP_Error on warning (with the installation otherwise successful, so the error code must be checked) or failure.

Uses · 13

• __()Retrieves the translation of $text.
• is_multisite()Determines whether Multisite is enabled.
• get_network()Retrieves network data given a network ID or network object.
• is_email()Verifies that an email is valid.
• populate_network_meta()Creates WordPress network meta and sets the default values.
• current_time()Retrieves the current time based on specified type.
• update_user_meta()Updates user meta field based on user ID.
• flush_rewrite_rules()Removes rewrite rules and then recreate rewrite rules.
• wp_remote_get()Performs an HTTP request using the GET method and returns its response.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_remote_retrieve_response_code()Retrieves only the response code from the raw response.
• WP_Error::__construct()Initializes the error.

Source

View on Trac ↗View on GitHub ↗

986function populate_network( $network_id = 1, $domain = '', $email = '', $site_name = '', $path = '/', $subdomain_install = false ) {987	global $wpdb, $current_site, $wp_rewrite;988 989	$network_id = (int) $network_id;990 991	$errors = new WP_Error();992	if ( '' === $domain ) {993		$errors->add( 'empty_domain', __( 'You must provide a domain name.' ) );994	}995	if ( '' === $site_name ) {996		$errors->add( 'empty_sitename', __( 'You must provide a name for your network of sites.' ) );997	}998 999	// Check for network collision.1000	$network_exists = false;1001	if ( is_multisite() ) {1002		if ( get_network( $network_id ) ) {1003			$errors->add( 'siteid_exists', __( 'The network already exists.' ) );1004		}1005	} else {1006		if ( $network_id === (int) $wpdb->get_var(1007			$wpdb->prepare( "SELECT id FROM $wpdb->site WHERE id = %d", $network_id )1008		) ) {1009			$errors->add( 'siteid_exists', __( 'The network already exists.' ) );1010		}1011	}1012 1013	if ( ! is_email( $email ) ) {1014		$errors->add( 'invalid_email', __( 'You must provide a valid email address.' ) );1015	}1016 1017	if ( $errors->has_errors() ) {1018		return $errors;1019	}1020 1021	if ( 1 === $network_id ) {1022		$wpdb->insert(1023			$wpdb->site,1024			array(1025				'domain' => $domain,1026				'path'   => $path,1027			)1028		);1029		$network_id = $wpdb->insert_id;1030	} else {1031		$wpdb->insert(1032			$wpdb->site,1033			array(1034				'domain' => $domain,1035				'path'   => $path,1036				'id'     => $network_id,1037			)1038		);1039	}1040 1041	populate_network_meta(1042		$network_id,1043		array(1044			'admin_email'       => $email,1045			'site_name'         => $site_name,1046			'subdomain_install' => $subdomain_install,1047		)1048	);1049 1050	/*1051	 * When upgrading from single to multisite, assume the current site will1052	 * become the main site of the network. When using populate_network()1053	 * to create another network in an existing multisite environment, skip1054	 * these steps since the main site of the new network has not yet been1055	 * created.1056	 */1057	if ( ! is_multisite() ) {1058		$current_site            = new stdClass();1059		$current_site->domain    = $domain;1060		$current_site->path      = $path;1061		$current_site->site_name = ucfirst( $domain );1062		$wpdb->insert(1063			$wpdb->blogs,1064			array(1065				'site_id'    => $network_id,

History

Introduced in 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 6.7.7 tag, from src/wp-admin/includes/schema.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.