display_setup_form( string|null $error = null )

Compatibility

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

Parameters

$errorstring|nulloptional

Error message to display, if any.Default: null

Performance profile

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

Scaling

Constant

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

Instructions

123–249

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

Plugin surface

1 hook

Third-party callbacks on 'blog_privacy_selector' 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
• sqldatabase query->get_var()called directly

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

What one call costs · 192 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   do_action( blog_privacy_selector )actionline 198 (+108 into the body)

   Enables the legacy 'Site visibility' privacy options.

Uses · 12

• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• _ex()Displays translated string with gettext context.
• _e()Displays translated text.
• esc_attr()Escaping for HTML attributes.
• sanitize_user()Sanitizes a username, stripping out unsafe characters.
• wp_generate_password()Generates a random password drawn from the defined set of characters.
• esc_attr_e()Displays translated text that has been escaped for safe use in an attribute.
• has_action()Checks if any action has been registered for a hook.
• __()Retrieves the translation of $text.
• checked()Outputs the HTML checked attribute.
• do_action()Calls the callback functions that have been added to an action hook.
• submit_button()Echoes a submit button, with provided text and appropriate class(es).

Source code

View on Trac ↗View on GitHub ↗

90function display_setup_form( $error = null ) {91	global $wpdb;92 93	$user_table = ( $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $wpdb->esc_like( $wpdb->users ) ) ) !== null );94 95	// Ensure that sites appear in search engines by default.96	$blog_public = 1;97	if ( isset( $_POST['weblog_title'] ) ) {98		$blog_public = isset( $_POST['blog_public'] ) ? (int) $_POST['blog_public'] : $blog_public;99	}100 101	$weblog_title = isset( $_POST['weblog_title'] ) ? trim( wp_unslash( $_POST['weblog_title'] ) ) : '';102	$user_name    = isset( $_POST['user_name'] ) ? trim( wp_unslash( $_POST['user_name'] ) ) : '';103	$admin_email  = isset( $_POST['admin_email'] ) ? trim( wp_unslash( $_POST['admin_email'] ) ) : '';104 105	if ( ! is_null( $error ) ) {106		?>107<h1><?php _ex( 'Welcome', 'Howdy' ); ?></h1>108<p class="message"><?php echo $error; ?></p>109<?php } ?>110<form id="setup" method="post" action="install.php?step=2" novalidate="novalidate">111	<table class="form-table" role="presentation">112		<tr>113			<th scope="row"><label for="weblog_title"><?php _e( 'Site Title' ); ?></label></th>114			<td><input name="weblog_title" type="text" id="weblog_title" size="25" value="<?php echo esc_attr( $weblog_title ); ?>" /></td>115		</tr>116		<tr>117			<th scope="row"><label for="user_login"><?php _e( 'Username' ); ?></label></th>118			<td>119			<?php120			if ( $user_table ) {121				_e( 'User(s) already exists.' );122				echo '<input name="user_name" type="hidden" value="admin" />';123			} else {124				?>125				<input name="user_name" type="text" id="user_login" size="25" aria-describedby="user-name-desc" value="<?php echo esc_attr( sanitize_user( $user_name, true ) ); ?>" />126				<p id="user-name-desc"><?php _e( 'Usernames can have only alphanumeric characters, spaces, underscores, hyphens, periods, and the @ symbol.' ); ?></p>127				<?php128			}129			?>130			</td>131		</tr>132		<?php if ( ! $user_table ) : ?>133		<tr class="form-field form-required user-pass1-wrap">134			<th scope="row">135				<label for="pass1">136					<?php _e( 'Password' ); ?>137				</label>138			</th>139			<td>140				<div class="wp-pwd">141					<?php $initial_password = isset( $_POST['admin_password'] ) ? stripslashes( $_POST['admin_password'] ) : wp_generate_password( 18 ); ?>142					<div class="password-input-wrapper">143						<input type="password" name="admin_password" id="pass1" class="regular-text" autocomplete="new-password" spellcheck="false" data-reveal="1" data-pw="<?php echo esc_attr( $initial_password ); ?>" aria-describedby="pass-strength-result admin-password-desc" />144						<div id="pass-strength-result" aria-live="polite"></div>145					</div>146					<button type="button" class="button wp-hide-pw user-new-password-toggle hide-if-no-js" data-start-masked="<?php echo (int) isset( $_POST['admin_password'] ); ?>" data-toggle="0" aria-label="<?php esc_attr_e( 'Hide password' ); ?>">147						<span class="dashicons dashicons-hidden"></span>148						<span class="text"><?php _e( 'Hide' ); ?></span>149					</button>150				</div>151				<p id="admin-password-desc"><span class="description important hide-if-no-js">152				<strong><?php _e( 'Important:' ); ?></strong>153				<?php /* translators: The non-breaking space prevents 1Password from thinking the text "log in" should trigger a password save prompt. */ ?>154				<?php _e( 'You will need this password to log&nbsp;in. Please store it in a secure location.' ); ?></span></p>155			</td>156		</tr>157		<tr class="form-field form-required user-pass2-wrap hide-if-js">158			<th scope="row">159				<label for="pass2"><?php _e( 'Repeat Password' ); ?>160					<span class="description"><?php _e( '(required)' ); ?></span>161				</label>162			</th>163			<td>164				<input type="password" name="admin_password2" id="pass2" autocomplete="new-password" spellcheck="false" />165			</td>166		</tr>167		<tr class="pw-weak">168			<th scope="row"><?php _e( 'Confirm Password' ); ?></th>169			<td>

Changelog

Introduced in 2.8.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/install.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.