network_step1( false|WP_Error $errors = false )

Compatibility

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

Parameters

$errorsfalse|WP_Erroroptional

Error object. Default false.Default: false

Performance profile

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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

135–301

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

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

• optionoption read or writeget_option()called directly
• hookthird-party callbacksdo_action()one call below network_step1()
• cacheobject cachewp_cache_get()one call below network_step1()
• serializeserialisationmaybe_unserialize()one call below network_step1()

Further down the call graph this can also reach query 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 · 500 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost network_step1() 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.

Uses · 18

• __()Retrieves the translation of $text.
• wp_admin_notice()Outputs an admin notice.
• get_option()Retrieves an option value based on an option name.
• admin_url()Retrieves the URL to the admin area for the current site.
• get_clean_basedomain()Get base domain of network.
• wp_nonce_field()Retrieves or display nonce hidden field for forms.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• _e()Displays translated text.
• apache_mod_loaded()Determines whether the specified module exist in the Apache config.
• allow_subdirectory_install()Allow subdirectory installation.
• got_mod_rewrite()Returns whether the server is running Apache with the mod_rewrite module loaded.
• allow_subdomain_install()Allow subdomain installation

Source code

View on Trac ↗View on GitHub ↗

113function network_step1( $errors = false ) {114	global $is_apache;115 116	if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {117		$cannot_define_constant_message  = '<strong>' . __( 'Error:' ) . '</strong> ';118		$cannot_define_constant_message .= sprintf(119			/* translators: %s: DO_NOT_UPGRADE_GLOBAL_TABLES */120			__( 'The constant %s cannot be defined when creating a network.' ),121			'<code>DO_NOT_UPGRADE_GLOBAL_TABLES</code>'122		);123 124		wp_admin_notice(125			$cannot_define_constant_message,126			array(127				'additional_classes' => array( 'error' ),128			)129		);130 131		echo '</div>';132		require_once ABSPATH . 'wp-admin/admin-footer.php';133		die();134	}135 136	$active_plugins = get_option( 'active_plugins' );137	if ( ! empty( $active_plugins ) ) {138		wp_admin_notice(139			'<strong>' . __( 'Warning:' ) . '</strong> ' . sprintf(140				/* translators: %s: URL to Plugins screen. */141				__( 'Please <a href="%s">deactivate your plugins</a> before enabling the Network feature.' ),142				admin_url( 'plugins.php?plugin_status=active' )143			),144			array( 'type' => 'warning' )145		);146		echo '<p>' . __( 'Once the network is created, you may reactivate your plugins.' ) . '</p>';147		echo '</div>';148		require_once ABSPATH . 'wp-admin/admin-footer.php';149		die();150	}151 152	// Strip standard port from hostname.153	$hostname = preg_replace( '/(?::80|:443)$/', '', get_clean_basedomain() );154 155	echo '<form method="post">';156 157	wp_nonce_field( 'install-network-1' );158 159	$error_codes = array();160	if ( is_wp_error( $errors ) ) {161		$network_created_error_message = '<p><strong>' . __( 'Error:' ) . '</strong> ' . __( 'The network could not be created.' ) . '</p>';162		foreach ( $errors->get_error_messages() as $error ) {163			$network_created_error_message .= "<p>$error</p>";164		}165		wp_admin_notice(166			$network_created_error_message,167			array(168				'additional_classes' => array( 'error' ),169				'paragraph_wrap'     => false,170			)171		);172		$error_codes = $errors->get_error_codes();173	}174 175	if ( ! empty( $_POST['sitename'] ) && ! in_array( 'empty_sitename', $error_codes, true ) ) {176		$site_name = $_POST['sitename'];177	} else {178		/* translators: %s: Default network title. */179		$site_name = sprintf( __( '%s Sites' ), get_option( 'blogname' ) );180	}181 182	if ( ! empty( $_POST['email'] ) && ! in_array( 'invalid_email', $error_codes, true ) ) {183		$admin_email = $_POST['email'];184	} else {185		$admin_email = get_option( 'admin_email' );186	}187	?>188	<p><?php _e( 'Welcome to the Network installation process!' ); ?></p>189	<p><?php _e( 'Fill in the information below and you&#8217;ll be on your way to creating a network of WordPress sites. Configuration files will be created in the next step.' ); ?></p>190	<?php191 192	if ( isset( $_POST['subdomain_install'] ) ) {

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.9.7 tag, from src/wp-admin/includes/network.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.