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.

Hooks 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

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' );

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