Title: display_setup_form
Published: April 25, 2014
Last modified: August 20, 2026

---

# display_setup_form( string|null $error = null )

## In this article

 * [Parameters](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#parameters)
 * [Source](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#source)
 * [Hooks](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#hooks)
 * [Related](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#wp--skip-link--target)

Displays installer setup form.

## 󠀁[Parameters](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#parameters)󠁿

 `$error`string|nulloptional

Error message to display, if any.

Default:`null`

## 󠀁[Source](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#source)󠁿

    ```php
    function display_setup_form( $error = null ) {
    	global $wpdb;

    	$user_table = ( $wpdb->get_var( $wpdb->prepare( 'SHOW TABLES LIKE %s', $wpdb->esc_like( $wpdb->users ) ) ) !== null );

    	// Ensure that sites appear in search engines by default.
    	$blog_public = 1;
    	if ( isset( $_POST['weblog_title'] ) ) {
    		$blog_public = isset( $_POST['blog_public'] ) ? (int) $_POST['blog_public'] : $blog_public;
    	}

    	$weblog_title = isset( $_POST['weblog_title'] ) ? trim( wp_unslash( $_POST['weblog_title'] ) ) : '';
    	$user_name    = isset( $_POST['user_name'] ) ? trim( wp_unslash( $_POST['user_name'] ) ) : '';
    	$admin_email  = isset( $_POST['admin_email'] ) ? trim( wp_unslash( $_POST['admin_email'] ) ) : '';

    	if ( ! is_null( $error ) ) {
    		?>
    <h1><?php _ex( 'Welcome', 'Howdy' ); ?></h1>
    <p class="message"><?php echo $error; ?></p>
    <?php } ?>
    <form id="setup" method="post" action="install.php?step=2" novalidate="novalidate">
    	<table class="form-table" role="presentation">
    		<tr>
    			<th scope="row"><label for="weblog_title"><?php _e( 'Site Title' ); ?></label></th>
    			<td><input name="weblog_title" type="text" id="weblog_title" size="25" value="<?php echo esc_attr( $weblog_title ); ?>" /></td>
    		</tr>
    		<tr>
    			<th scope="row"><label for="user_login"><?php _e( 'Username' ); ?></label></th>
    			<td>
    			<?php
    			if ( $user_table ) {
    				_e( 'User(s) already exists.' );
    				echo '<input name="user_name" type="hidden" value="admin" />';
    			} else {
    				?>
    				<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 ) ); ?>" />
    				<p id="user-name-desc"><?php _e( 'Usernames can have only alphanumeric characters, spaces, underscores, hyphens, periods, and the @ symbol.' ); ?></p>
    				<?php
    			}
    			?>
    			</td>
    		</tr>
    		<?php if ( ! $user_table ) : ?>
    		<tr class="form-field form-required user-pass1-wrap">
    			<th scope="row">
    				<label for="pass1">
    					<?php _e( 'Password' ); ?>
    				</label>
    			</th>
    			<td>
    				<div class="wp-pwd">
    					<?php $initial_password = isset( $_POST['admin_password'] ) ? stripslashes( $_POST['admin_password'] ) : wp_generate_password( 18 ); ?>
    					<div class="password-input-wrapper">
    						<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" />
    						<div id="pass-strength-result" aria-live="polite"></div>
    					</div>
    					<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' ); ?>">
    						<span class="dashicons dashicons-hidden"></span>
    						<span class="text"><?php _e( 'Hide' ); ?></span>
    					</button>
    				</div>
    				<p id="admin-password-desc"><span class="description important hide-if-no-js">
    				<strong><?php _e( 'Important:' ); ?></strong>
    				<?php /* translators: The non-breaking space prevents 1Password from thinking the text "log in" should trigger a password save prompt. */ ?>
    				<?php _e( 'You will need this password to log&nbsp;in. Please store it in a secure location.' ); ?></span></p>
    			</td>
    		</tr>
    		<tr class="form-field form-required user-pass2-wrap hide-if-js">
    			<th scope="row">
    				<label for="pass2"><?php _e( 'Repeat Password' ); ?>
    					<span class="description"><?php _e( '(required)' ); ?></span>
    				</label>
    			</th>
    			<td>
    				<input type="password" name="admin_password2" id="pass2" autocomplete="new-password" spellcheck="false" />
    			</td>
    		</tr>
    		<tr class="pw-weak">
    			<th scope="row"><?php _e( 'Confirm Password' ); ?></th>
    			<td>
    				<label>
    					<input type="checkbox" name="pw_weak" class="pw-checkbox" />
    					<?php _e( 'Confirm use of weak password' ); ?>
    				</label>
    			</td>
    		</tr>
    		<?php endif; ?>
    		<tr>
    			<th scope="row"><label for="admin_email"><?php _e( 'Your Email' ); ?></label></th>
    			<td><input name="admin_email" type="email" id="admin_email" size="25" aria-describedby="admin-email-desc" value="<?php echo esc_attr( $admin_email ); ?>" />
    			<p id="admin-email-desc"><?php _e( 'Double-check your email address before continuing.' ); ?></p></td>
    		</tr>
    		<?php $blog_privacy_selector_title = has_action( 'blog_privacy_selector' ) ? __( 'Site visibility' ) : __( 'Search engine visibility' ); ?>
    		<tr>
    			<th scope="row"><?php echo $blog_privacy_selector_title; ?></th>
    			<td>
    				<fieldset>
    					<legend class="screen-reader-text"><span><?php echo $blog_privacy_selector_title; ?></span></legend>
    					<?php
    					if ( has_action( 'blog_privacy_selector' ) ) {
    						?>
    						<input id="blog-public" type="radio" name="blog_public" value="1" <?php checked( 1, $blog_public ); ?> />
    						<label for="blog-public"><?php _e( 'Allow search engines to index this site' ); ?></label><br />
    						<input id="blog-norobots" type="radio" name="blog_public"  aria-describedby="public-desc" value="0" <?php checked( 0, $blog_public ); ?> />
    						<label for="blog-norobots"><?php _e( 'Discourage search engines from indexing this site' ); ?></label>
    						<p id="public-desc" class="description"><?php _e( 'Note: Discouraging search engines does not block access to your site &mdash; it is up to search engines to honor your request.' ); ?></p>
    						<?php
    						/** This action is documented in wp-admin/options-reading.php */
    						do_action( 'blog_privacy_selector' );
    					} else {
    						?>
    						<label for="blog_public"><input name="blog_public" type="checkbox" id="blog_public" aria-describedby="privacy-desc" value="0" <?php checked( 0, $blog_public ); ?> />
    						<?php _e( 'Discourage search engines from indexing this site' ); ?></label>
    						<p id="privacy-desc" class="description"><?php _e( 'It is up to search engines to honor this request.' ); ?></p>
    					<?php } ?>
    				</fieldset>
    			</td>
    		</tr>
    	</table>
    	<p class="step"><?php submit_button( __( 'Install WordPress' ), 'large', 'Submit', false, array( 'id' => 'submit' ) ); ?></p>
    	<input type="hidden" name="language" value="<?php echo isset( $_REQUEST['language'] ) ? esc_attr( $_REQUEST['language'] ) : ''; ?>" />
    </form>
    	<?php
    } // End display_setup_form().
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-admin/install.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-admin/install.php#L90)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-admin/install.php#L90-L213)

## 󠀁[Hooks](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#hooks)󠁿

 [do_action( ‘blog_privacy_selector’ )](https://developer.wordpress.org/reference/hooks/blog_privacy_selector/)

Enables the legacy ‘Site visibility’ privacy options.

## 󠀁[Related](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#related)󠁿

| Uses | Description | 
| [wpdb::esc_like()](https://developer.wordpress.org/reference/classes/wpdb/esc_like/)`wp-includes/class-wpdb.php` |

First half of escaping for `LIKE` special characters `%` and `_` before preparing for SQL.

  | 
| [submit_button()](https://developer.wordpress.org/reference/functions/submit_button/)`wp-admin/includes/template.php` |

Echoes a submit button, with provided text and appropriate class(es).

  | 
| [_ex()](https://developer.wordpress.org/reference/functions/_ex/)`wp-includes/l10n.php` |

Displays translated string with gettext context.

  | 
| [esc_attr_e()](https://developer.wordpress.org/reference/functions/esc_attr_e/)`wp-includes/l10n.php` |

Displays translated text that has been escaped for safe use in an attribute.

  | 
| [sanitize_user()](https://developer.wordpress.org/reference/functions/sanitize_user/)`wp-includes/formatting.php` |

Sanitizes a username, stripping out unsafe characters.

  | 
| [wp_generate_password()](https://developer.wordpress.org/reference/functions/wp_generate_password/)`wp-includes/pluggable.php` |

Generates a random password drawn from the defined set of characters.

  | 
| [checked()](https://developer.wordpress.org/reference/functions/checked/)`wp-includes/general-template.php` |

Outputs the HTML checked attribute.

  | 
| [has_action()](https://developer.wordpress.org/reference/functions/has_action/)`wp-includes/plugin.php` |

Checks if any action has been registered for a hook.

  | 
| [_e()](https://developer.wordpress.org/reference/functions/_e/)`wp-includes/l10n.php` |

Displays translated text.

  | 
| [__()](https://developer.wordpress.org/reference/functions/__/)`wp-includes/l10n.php` |

Retrieves the translation of $text.

  | 
| [wp_unslash()](https://developer.wordpress.org/reference/functions/wp_unslash/)`wp-includes/formatting.php` |

Removes slashes from a string or recursively removes slashes from strings within an array.

  | 
| [esc_attr()](https://developer.wordpress.org/reference/functions/esc_attr/)`wp-includes/formatting.php` |

Escaping for HTML attributes.

  | 
| [do_action()](https://developer.wordpress.org/reference/functions/do_action/)`wp-includes/plugin.php` |

Calls the callback functions that have been added to an action hook.

  | 
| [wpdb::get_var()](https://developer.wordpress.org/reference/classes/wpdb/get_var/)`wp-includes/class-wpdb.php` |

Retrieves one value from the database.

  | 
| [wpdb::prepare()](https://developer.wordpress.org/reference/classes/wpdb/prepare/)`wp-includes/class-wpdb.php` |

Prepares a SQL query for safe execution.

  |

[Show 10 more](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#)
[Show less](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#)

## 󠀁[Changelog](https://developer.wordpress.org/reference/functions/display_setup_form/?output_format=md#changelog)󠁿

| Version | Description | 
| [2.8.0](https://developer.wordpress.org/reference/since/2.8.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Ffunctions%2Fdisplay_setup_form%2F)
before being able to contribute a note or feedback.