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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

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.

Performance profile

How much work a call to populate_network() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Reaches an outbound HTTP request via wp_remote_get().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

33–251

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 282.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• httpoutbound HTTP requestwp_remote_get()called directly
• sqldatabase query->get_var()called directly
• hookthird-party callbacksapply_filters()one call below populate_network()
• querycontent queryget_user_by()one call below populate_network()
• optionoption read or writeget_option()one call below populate_network()
• cacheobject cachewp_cache_delete()one call below populate_network()

Further down the call graph this can also reach serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 408 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost populate_network() can have, taken from its control-flow graph on PHP 8.5.

Uses · 15

• __()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.
• wp_next_scheduled()Retrieves the timestamp of the next scheduled event for the given hook.
• wp_clear_scheduled_hook()Unschedules all events attached to the hook with the specified arguments.
• 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.

Source code

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	// Remove the cron event since Recovery Mode is not used in Multisite.1051	if ( wp_next_scheduled( 'recovery_mode_clean_expired_keys' ) ) {1052		wp_clear_scheduled_hook( 'recovery_mode_clean_expired_keys' );1053	}1054 1055	/*1056	 * When upgrading from single to multisite, assume the current site will1057	 * become the main site of the network. When using populate_network()1058	 * to create another network in an existing multisite environment, skip1059	 * these steps since the main site of the new network has not yet been1060	 * created.1061	 */1062	if ( ! is_multisite() ) {1063		$current_site            = new stdClass();1064		$current_site->domain    = $domain;1065		$current_site->path      = $path;

Changelog

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.8.8 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.