insert_blog( string $domain, string $path, int $site_id ): int|false
- Since
- MU (3.0.0)
- Source
wp-includes/ms-deprecated.php:572
Description
This function creates a row in the wp_blogs table and returns the new blog's ID. It is the first step in creating a new blog.
Compatibility
Deprecated in WordPress 5.1.0. Use wp_insert_site()
- 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 domain of the new site.
$pathstring- The path of the new site.
$site_idint- Unless you're running a multi-network install, be sure to set this value to 1.
Return value
int|false- The ID of the new row
Performance profile
How much work a call to insert_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
- 21–24
- Plugin surface
- None
- Called by
- 1
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 25.
Nothing here hands control to plugin code.
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()one call below insert_blog() - optionnetwork option
get_network_option()one call below insert_blog() - cacheobject cache
wp_cache_delete()one call below insert_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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost insert_blog() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_wp_error() | 21 | _deprecated_function(), wp_insert_site(), is_wp_error() |
!is_wp_error() | 24 | _deprecated_function(), wp_insert_site(), is_wp_error(), clean_blog_cache() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 25 instructions, 21–24 executed per call, 1 branch. 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 · 4
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- wp_insert_site()Inserts a new site into the database.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- clean_blog_cache()Clean the blog cache
Used by · 1
- create_empty_blog()Create an empty blog.
Source code
function insert_blog($domain, $path, $site_id) { _deprecated_function( __FUNCTION__, '5.1.0', 'wp_insert_site()' ); $data = array( 'domain' => $domain, 'path' => $path, 'site_id' => $site_id, ); $site_id = wp_insert_site( $data ); if ( is_wp_error( $site_id ) ) { return false; } clean_blog_cache( $site_id ); return $site_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 6.8.8 tag, from
src/wp-includes/ms-deprecated.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.