populate_network_meta( int $network_id, array $meta = array() )

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_idint

Network ID to populate meta for.

$metaarrayoptional

Custom meta $key => $value pairs to use. Default empty array.Default: array()

Performance profile

How much work a call to populate_network_meta() 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

Heavy

Reaches the database via ->query().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

147–185

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

Plugin surface

1 hook

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

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_user_by()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_delete()called directly
• hookthird-party callbacksapply_filters()called directly
• sqldatabase query->query()called directly
• serializeserialisationmaybe_unserialize()one call below populate_network_meta()

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

What one call costs · 72 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while populate_network_meta() runs, in this order:

1. 1
   apply_filters( populate_network_meta )filterline 1294 (+129 into the body)

   Filters meta for a network on creation.

Uses · 16

• get_user_by()Retrieves user info by a given field.
• wp_get_current_user()Retrieves the current user object.
• get_option()Retrieves an option value based on an option name.
• wp_get_theme()Gets a WP_Theme object for a theme.
• clean_network_cache()Removes a network from the object cache.
• wp_cache_delete()Removes the cache contents matching key and group.
• is_multisite()Determines whether Multisite is enabled.
• get_users()Retrieves list of users matching criteria.
• get_site_option()Retrieve an option value for the current network based on name of option.
• __()Retrieves the translation of $text.
• get_allowed_mime_types()Retrieves the list of allowed mime types and file extensions.
• get_locale()Retrieves the current locale.

Used by · 1

• populate_network()Populate network settings.

Source code

View on Trac ↗View on GitHub ↗

1165function populate_network_meta( $network_id, array $meta = array() ) {1166	global $wpdb, $wp_db_version;1167 1168	$network_id = (int) $network_id;1169 1170	$email             = ! empty( $meta['admin_email'] ) ? $meta['admin_email'] : '';1171	$subdomain_install = isset( $meta['subdomain_install'] ) ? (int) $meta['subdomain_install'] : 0;1172 1173	// If a user with the provided email does not exist, default to the current user as the new network admin.1174	$site_user = ! empty( $email ) ? get_user_by( 'email', $email ) : false;1175	if ( false === $site_user ) {1176		$site_user = wp_get_current_user();1177	}1178 1179	if ( empty( $email ) ) {1180		$email = $site_user->user_email;1181	}1182 1183	$template       = get_option( 'template' );1184	$stylesheet     = get_option( 'stylesheet' );1185	$allowed_themes = array( $stylesheet => true );1186 1187	if ( $template !== $stylesheet ) {1188		$allowed_themes[ $template ] = true;1189	}1190 1191	if ( WP_DEFAULT_THEME !== $stylesheet && WP_DEFAULT_THEME !== $template ) {1192		$allowed_themes[ WP_DEFAULT_THEME ] = true;1193	}1194 1195	// If WP_DEFAULT_THEME doesn't exist, also include the latest core default theme.1196	if ( ! wp_get_theme( WP_DEFAULT_THEME )->exists() ) {1197		$core_default = WP_Theme::get_core_default_theme();1198		if ( $core_default ) {1199			$allowed_themes[ $core_default->get_stylesheet() ] = true;1200		}1201	}1202 1203	if ( function_exists( 'clean_network_cache' ) ) {1204		clean_network_cache( $network_id );1205	} else {1206		wp_cache_delete( $network_id, 'networks' );1207	}1208 1209	if ( ! is_multisite() ) {1210		$site_admins = array( $site_user->user_login );1211		$users       = get_users(1212			array(1213				'fields' => array( 'user_login' ),1214				'role'   => 'administrator',1215			)1216		);1217		if ( $users ) {1218			foreach ( $users as $user ) {1219				$site_admins[] = $user->user_login;1220			}1221 1222			$site_admins = array_unique( $site_admins );1223		}1224	} else {1225		$site_admins = get_site_option( 'site_admins' );1226	}1227 1228	/* translators: Do not translate USERNAME, SITE_NAME, BLOG_URL, PASSWORD: those are placeholders. */1229	$welcome_email = __(1230		'Howdy USERNAME,1231 1232Your new SITE_NAME site has been successfully set up at:1233BLOG_URL1234 1235You can log in to the administrator account with the following information:1236 1237Username: USERNAME1238Password: PASSWORD1239Log in here: BLOG_URLwp-login.php1240 1241We hope you enjoy your new site. Thanks!1242 1243--The Team @ SITE_NAME'1244	);

Changelog

Introduced in 5.1.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.