show_user_form( string $user_name = '', string $user_email = '', WP_Error|string $errors = '' )
- Since
- MU (3.0.0)
- Source
wp-signup.php:278
Compatibility
- WordPress
- since MU (3.0.0)
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$user_namestringoptional- The entered username.Default:
'' $user_emailstringoptional- The entered email address.Default:
'' $errorsWP_Error|stringoptional- A WP_Error object containing existing errors. Defaults to empty string.Default:
''
Performance profile
How much work a call to show_user_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
- Trivial
- Scaling
- Constant
- Instructions
- 65–79
- Plugin surface
- 1 hook
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 79.
Third-party callbacks on 'signup_extra_fields' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()called directly
Further down the call graph this can also reach option, cache, serialize, 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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost show_user_form() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 65–79 | is_wp_error(), __(), ->get_error_message(), esc_attr(), _e(), __(), ->get_error_message(), esc_attr(), _e(), ->get_error_message(), do_action() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 79 instructions, 65–79 executed per call, 4 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while show_user_form() runs, in this order:
- do_action( signup_extra_fields )actionline 321 (+43 into the body)
Fires at the end of the new user account registration form.
Uses · 6
- is_wp_error()Checks whether the given variable is a WordPress Error.
- __()Retrieves the translation of $text.
- esc_attr()Escaping for HTML attributes.
- _e()Displays translated text.
- do_action()Calls the callback functions that have been added to an action hook.
- WP_Error::__construct()Initializes the error.
Used by · 1
- signup_user()Shows a form for a visitor to sign up for a new user account.
Source code
function show_user_form( $user_name = '', $user_email = '', $errors = '' ) { if ( ! is_wp_error( $errors ) ) { $errors = new WP_Error(); } // Username. echo '<label for="user_name">' . __( 'Username' ) . '</label>'; $errmsg_username = $errors->get_error_message( 'user_name' ); $errmsg_username_aria = ''; if ( $errmsg_username ) { $errmsg_username_aria = 'wp-signup-username-error '; echo '<p class="error" id="wp-signup-username-error">' . $errmsg_username . '</p>'; } ?> <input name="user_name" type="text" id="user_name" value="<?php echo esc_attr( $user_name ); ?>" autocapitalize="none" autocorrect="off" maxlength="60" autocomplete="username" required="required" aria-describedby="<?php echo $errmsg_username_aria; ?>wp-signup-username-description" /> <p id="wp-signup-username-description"><?php _e( '(Must be at least 4 characters, lowercase letters and numbers only.)' ); ?></p> <?php // Email address. echo '<label for="user_email">' . __( 'Email Address' ) . '</label>'; $errmsg_email = $errors->get_error_message( 'user_email' ); $errmsg_email_aria = ''; if ( $errmsg_email ) { $errmsg_email_aria = 'wp-signup-email-error '; echo '<p class="error" id="wp-signup-email-error">' . $errmsg_email . '</p>'; } ?> <input name="user_email" type="email" id="user_email" value="<?php echo esc_attr( $user_email ); ?>" maxlength="200" autocomplete="email" required="required" aria-describedby="<?php echo $errmsg_email_aria; ?>wp-signup-email-description" /> <p id="wp-signup-email-description"><?php _e( 'Your registration email is sent to this address. (Double-check your email address before continuing.)' ); ?></p> <?php // Extra fields. $errmsg_generic = $errors->get_error_message( 'generic' ); if ( $errmsg_generic ) { echo '<p class="error" id="wp-signup-generic-error">' . $errmsg_generic . '</p>'; } /** * Fires at the end of the new user account registration form. * * @since 3.0.0 * * @param WP_Error $errors A WP_Error object containing 'user_name' or 'user_email' errors. */ do_action( 'signup_extra_fields', $errors );}Changelog
Introduced in MU (3.0.0). Unchanged from 6.7.7 through 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-signup.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.