wp_is_site_initialized( int|WP_Site $site_id ): bool
- Since
- 5.1.0
- Source
wp-includes/ms-site.php:906
Description
A site is considered initialized when its database tables are present.
Compatibility
- WordPress
- since 5.1.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
$site_idint|WP_Site- Site ID or object.
Return value
bool- True if the site is initialized, false otherwise.
Performance profile
How much work a call to wp_is_site_initialized() 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
- Heavy
- Scaling
- Constant
- Instructions
- 16–52
- Plugin surface
- 1 hook
- Called by
- 3
Reaches the database via ->get_results().
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 54.
Third-party callbacks on 'pre_wp_is_site_initialized' run inside this call, and their cost is not bounded by anything here.
3 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 - sqldatabase query
->get_results()called directly - cacheobject cache
wp_cache_switch_to_blog()one call below wp_is_site_initialized()
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 wp_is_site_initialized() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$pre !== null | 16–18 | apply_filters() |
$pre === null && $site_id === false | 33–35 | apply_filters(), get_current_blog_id(), ->suppress_errors(), ->get_results(), ->suppress_errors() |
$pre === null && $site_id === false | 41–43 | apply_filters(), get_current_blog_id(), ->suppress_errors(), ->get_results(), ->suppress_errors(), restore_current_blog(), add_action() |
$pre === null && $site_id !== false | 42–44 | apply_filters(), get_current_blog_id(), remove_action(), switch_to_blog(), ->suppress_errors(), ->get_results(), ->suppress_errors() |
$pre === null && $site_id !== false | 50–52 | apply_filters(), get_current_blog_id(), remove_action(), switch_to_blog(), ->suppress_errors(), ->get_results(), ->suppress_errors(), restore_current_blog(), add_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: 54 instructions, 16–52 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 wp_is_site_initialized() runs, in this order:
- apply_filters( pre_wp_is_site_initialized )filterline 926 (+20 into the body)
Filters the check for whether a site is initialized before the database is accessed.
Uses · 6
- apply_filters()Calls the callback functions that have been added to a filter hook.
- get_current_blog_id()Retrieves the current site ID.
- remove_action()Removes a callback function from an action hook.
- switch_to_blog()Switches the current blog.
- restore_current_blog()Restores the current blog, after calling switch_to_blog().
- add_action()Adds a callback function to an action hook.
Used by · 3
- wp_initialize_site()Runs the initialization routine for a given site.
- wp_uninitialize_site()Runs the uninitialization routine for a given site.
- wp_update_blog_public_option_on_site_update()Updates the `blog_public` option for a given site ID.
Source code
function wp_is_site_initialized( $site_id ) { global $wpdb; if ( is_object( $site_id ) ) { $site_id = $site_id->blog_id; } $site_id = (int) $site_id; /** * Filters the check for whether a site is initialized before the database is accessed. * * Returning a non-null value will effectively short-circuit the function, returning * that value instead. * * @since 5.1.0 * * @param bool|null $pre The value to return instead. Default null * to continue with the check. * @param int $site_id The site ID that is being checked. */ $pre = apply_filters( 'pre_wp_is_site_initialized', null, $site_id ); if ( null !== $pre ) { return (bool) $pre; } $switch = false; if ( get_current_blog_id() !== $site_id ) { $switch = true; remove_action( 'switch_blog', 'wp_switch_roles_and_user', 1 ); switch_to_blog( $site_id ); } $suppress = $wpdb->suppress_errors(); $result = (bool) $wpdb->get_results( "DESCRIBE {$wpdb->posts}" ); $wpdb->suppress_errors( $suppress ); if ( $switch ) { restore_current_blog(); add_action( 'switch_blog', 'wp_switch_roles_and_user', 1, 2 ); } return $result;}Changelog
Introduced in 5.1.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.7.7 tag, from
src/wp-includes/ms-site.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.