wpmu_create_blog( string $domain, string $path, string $title, int $user_id, array $options = array(), int $network_id = 1 ): int|WP_Error
- Since
- MU (3.0.0)
- Source
wp-includes/ms-functions.php:1404
Description
This function runs when a user self-registers a new site as well as when a Super Admin creates a new site. Hook to 'wpmu_new_blog' for events that should affect all new sites.
On subdirectory installations, $domain is the same as the main site's domain, and the path is the subdirectory name (eg 'example.com' and '/blog1/'). On subdomain installations, $domain is the new subdomain + root domain (eg 'blog1.example.com'), and $path is '/'.
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
$domainstring- The new site's domain.
$pathstring- The new site's path.
$titlestring- The new site's title.
$user_idint- The user ID of the new site's admin.
$optionsarrayoptional- Array of key=>value pairs used to set initial site options.
If valid status keys are included ('public', 'archived', 'mature', 'spam', 'deleted', or 'lang_id') the given site status(es) will be updated. Otherwise, keys and values will be used to set options for the new site. Default empty array.Default:array() $network_idintoptional- Network ID. Only relevant on multi-network installations.
Default 1.Default:1
Return value
int|WP_Error- Returns WP_Error object on failure, the new site ID on success.
Performance profile
How much work a call to wpmu_create_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
- 32–65
- Plugin surface
- None
- Called by
- 2
Reads stored settings via get_network_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 74.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- cacheobject cache
wp_cache_set_sites_last_changed()called directly - hookthird-party callbacks
apply_filters()one call below wpmu_create_blog() - optionnetwork option
get_network_option()one call below wpmu_create_blog()
Further down the call graph this can also reach 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 · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wpmu_create_blog() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
domain_exists() | 32 | wp_parse_args(), strip_tags(), domain_exists(), __() |
!domain_exists() && wp_installing() && is_wp_error() | 60 | wp_parse_args(), strip_tags(), domain_exists(), wp_installing(), array_intersect_key(), domain(), array_diff_key(), array_merge(), wp_insert_site(), is_wp_error() |
!domain_exists() && wp_installing() && !is_wp_error() | 62 | wp_parse_args(), strip_tags(), domain_exists(), wp_installing(), array_intersect_key(), domain(), array_diff_key(), array_merge(), wp_insert_site(), is_wp_error(), wp_cache_set_sites_last_changed() |
!domain_exists() && !wp_installing() && is_wp_error() | 63 | wp_parse_args(), strip_tags(), domain_exists(), wp_installing(), wp_installing(), array_intersect_key(), domain(), array_diff_key(), array_merge(), wp_insert_site(), is_wp_error() |
!domain_exists() && !wp_installing() && !is_wp_error() | 65 | wp_parse_args(), strip_tags(), domain_exists(), wp_installing(), wp_installing(), array_intersect_key(), domain(), array_diff_key(), array_merge(), wp_insert_site(), is_wp_error(), wp_cache_set_sites_last_changed() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 74 instructions, 32–65 executed per call, 3 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.
Uses · 8
- wp_parse_args()Merges user defined arguments into defaults array.
- domain_exists()Checks whether a site name is already taken.
- __()Retrieves the translation of $text.
- wp_installing()Checks or sets whether WordPress is in "installation" mode.
- wp_insert_site()Inserts a new site into the database.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- wp_cache_set_sites_last_changed()Sets the last changed time for the 'sites' cache group.
- WP_Error::__construct()Initializes the error.
Used by · 2
- validate_another_blog_signup()Validates a new site sign-up for an existing user.
- wpmu_activate_signup()Activates a signup.
Source code
function wpmu_create_blog( $domain, $path, $title, $user_id, $options = array(), $network_id = 1 ) { $defaults = array( 'public' => 0, ); $options = wp_parse_args( $options, $defaults ); $title = strip_tags( $title ); $user_id = (int) $user_id; // Check if the domain has been used already. We should return an error message. if ( domain_exists( $domain, $path, $network_id ) ) { return new WP_Error( 'blog_taken', __( 'Sorry, that site already exists!' ) ); } if ( ! wp_installing() ) { wp_installing( true ); } $allowed_data_fields = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' ); $site_data = array_merge( array( 'domain' => $domain, 'path' => $path, 'network_id' => $network_id, ), array_intersect_key( $options, array_flip( $allowed_data_fields ) ) ); // Data to pass to wp_initialize_site(). $site_initialization_data = array( 'title' => $title, 'user_id' => $user_id, 'options' => array_diff_key( $options, array_flip( $allowed_data_fields ) ), ); $blog_id = wp_insert_site( array_merge( $site_data, $site_initialization_data ) ); if ( is_wp_error( $blog_id ) ) { return $blog_id; } wp_cache_set_sites_last_changed(); return $blog_id;}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.0.4 tag, from
src/wp-includes/ms-functions.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.