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

42–269

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

Plugin surface

3 hooks

Third-party callbacks on 'before_populate_network', 'after_upgrade_to_multisite', 'after_populate_network' run inside this call, and their cost is not bounded by anything here.

Called by

0

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

What it touches

• hookthird-party callbacksdo_action()called directly
• httpoutbound HTTP requestwp_remote_get()called directly
• sqldatabase query->get_var()called directly
• 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.

Hooks and filters fired · 3

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

1. 1
   do_action( before_populate_network )actionline 1022 (+17 into the body)

   Fires before a network is populated.

2. 2
   do_action( after_upgrade_to_multisite )actionline 1154 (+149 into the body)

   Fires after a network is created when converting a single site to multisite.

3. 3
   do_action( after_populate_network )actionline 1214 (+209 into the body)

   Fires after a network is fully populated.

Uses · 16

• do_action()Calls the callback functions that have been added to an action hook.
• __()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.

Source code

View on Trac ↗View on GitHub ↗

1005function populate_network( $network_id = 1, $domain = '', $email = '', $site_name = '', $path = '/', $subdomain_install = false ) {1006	global $wpdb, $current_site, $wp_rewrite;1007 1008	$network_id = (int) $network_id;1009 1010	/**1011	 * Fires before a network is populated.1012	 *1013	 * @since 6.9.01014	 *1015	 * @param int    $network_id        ID of network to populate.1016	 * @param string $domain            The domain name for the network.1017	 * @param string $email             Email address for the network administrator.1018	 * @param string $site_name         The name of the network.1019	 * @param string $path              The path to append to the network's domain name.1020	 * @param bool   $subdomain_install Whether the network is a subdomain installation or a subdirectory installation.1021	 */1022	do_action( 'before_populate_network', $network_id, $domain, $email, $site_name, $path, $subdomain_install );1023 1024	$errors = new WP_Error();1025	if ( '' === $domain ) {1026		$errors->add( 'empty_domain', __( 'You must provide a domain name.' ) );1027	}1028	if ( '' === $site_name ) {1029		$errors->add( 'empty_sitename', __( 'You must provide a name for your network of sites.' ) );1030	}1031 1032	// Check for network collision.1033	if ( is_multisite() ) {1034		if ( get_network( $network_id ) ) {1035			$errors->add( 'siteid_exists', __( 'The network already exists.' ) );1036		}1037	} else {1038		if ( $network_id === (int) $wpdb->get_var(1039			$wpdb->prepare( "SELECT id FROM $wpdb->site WHERE id = %d", $network_id )1040		) ) {1041			$errors->add( 'siteid_exists', __( 'The network already exists.' ) );1042		}1043	}1044 1045	if ( ! is_email( $email ) ) {1046		$errors->add( 'invalid_email', __( 'You must provide a valid email address.' ) );1047	}1048 1049	if ( $errors->has_errors() ) {1050		return $errors;1051	}1052 1053	if ( 1 === $network_id ) {1054		$wpdb->insert(1055			$wpdb->site,1056			array(1057				'domain' => $domain,1058				'path'   => $path,1059			)1060		);1061		$network_id = $wpdb->insert_id;1062	} else {1063		$wpdb->insert(1064			$wpdb->site,1065			array(1066				'domain' => $domain,1067				'path'   => $path,1068				'id'     => $network_id,1069			)1070		);1071	}1072 1073	populate_network_meta(1074		$network_id,1075		array(1076			'admin_email'       => $email,1077			'site_name'         => $site_name,1078			'subdomain_install' => $subdomain_install,1079		)1080	);1081 1082	// Remove the cron event since Recovery Mode is not used in Multisite.1083	if ( wp_next_scheduled( 'recovery_mode_clean_expired_keys' ) ) {1084		wp_clear_scheduled_hook( 'recovery_mode_clean_expired_keys' );

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