signup_blog( string $user_name = '', string $user_email = '', string $blogname = '', string $blog_title = '', WP_Error|string $errors = '' )
- Since
- MU (3.0.0)
- Source
wp-signup.php:735
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 username.Default:
'' $user_emailstringoptional- The user's email address.Default:
'' $blognamestringoptional- The site name.Default:
'' $blog_titlestringoptional- The site title.Default:
'' $errorsWP_Error|stringoptional- A WP_Error object containing existing errors. Defaults to empty string.Default:
''
Performance profile
How much work a call to signup_blog() 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
- Scaling
- Constant
- Instructions
- 59–63
- Plugin surface
- 2 hooks
- Called by
- 2
Reads stored settings via get_site_option(), cached per request but not free on a cold cache.
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 63.
Third-party callbacks on 'signup_blog_init', 'signup_hidden_fields' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - optionnetwork option
get_site_option()one call below signup_blog()
Further down the call graph this can also reach cache, serialize, transient, http 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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost signup_blog() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 59–63 | is_wp_error(), apply_filters(), esc_attr(), esc_attr(), do_action(), show_blog_form(), esc_attr_e() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 63 instructions, 59–63 executed per call, 2 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 · 2
2 hooks fire while signup_blog() runs, in this order:
- apply_filters( signup_blog_init )filterline 763 (+28 into the body)
Filters the default site creation variables for the site sign-up form.
- do_action( signup_hidden_fields )actionline 781 (+46 into the body)
Fires when hidden sign-up form fields output when creating another site or user.
Uses · 7
- is_wp_error()Checks whether the given variable is a WordPress Error.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- esc_attr()Escaping for HTML attributes.
- do_action()Calls the callback functions that have been added to an action hook.
- show_blog_form()Generates and displays the Sign-up and Create Site forms.
- esc_attr_e()Displays translated text that has been escaped for safe use in an attribute.
- WP_Error::__construct()Initializes the error.
Used by · 2
- validate_blog_signup()Validates new site signup.
- validate_user_signup()Validates the new user sign-up.
Source code
function signup_blog( $user_name = '', $user_email = '', $blogname = '', $blog_title = '', $errors = '' ) { if ( ! is_wp_error( $errors ) ) { $errors = new WP_Error(); } $signup_blog_defaults = array( 'user_name' => $user_name, 'user_email' => $user_email, 'blogname' => $blogname, 'blog_title' => $blog_title, 'errors' => $errors, ); /** * Filters the default site creation variables for the site sign-up form. * * @since 3.0.0 * * @param array $signup_blog_defaults { * An array of default site creation variables. * * @type string $user_name The user username. * @type string $user_email The user email address. * @type string $blogname The blogname. * @type string $blog_title The title of the site. * @type WP_Error $errors A WP_Error object with possible errors relevant to new site creation variables. * } */ $filtered_results = apply_filters( 'signup_blog_init', $signup_blog_defaults ); $user_name = $filtered_results['user_name']; $user_email = $filtered_results['user_email']; $blogname = $filtered_results['blogname']; $blog_title = $filtered_results['blog_title']; $errors = $filtered_results['errors']; if ( empty( $blogname ) ) { $blogname = $user_name; } ?> <form id="setupform" method="post" action="wp-signup.php"> <input type="hidden" name="stage" value="validate-blog-signup" /> <input type="hidden" name="user_name" value="<?php echo esc_attr( $user_name ); ?>" /> <input type="hidden" name="user_email" value="<?php echo esc_attr( $user_email ); ?>" /> <?php /** This action is documented in wp-signup.php */ do_action( 'signup_hidden_fields', 'validate-site' ); ?> <?php show_blog_form( $blogname, $blog_title, $errors ); ?> <p class="submit"><input type="submit" name="submit" class="submit" value="<?php esc_attr_e( 'Sign up' ); ?>" /></p> </form> <?php}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 6.8.8 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.