WP_Site::get_details(): stdClass
- Since
- 4.6.0
- Source
wp-includes/class-wp-site.php:329
Description
This method is used internally to lazy-load the extended properties of a site.
Compatibility
- WordPress
- since 4.6.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.
Return value
stdClass- A raw site object with all details included.
Performance profile
How much work a call to WP_Site::get_details() 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
- Scales with input
- Instructions
- 23–67
- Plugin surface
- 2 hooks
- Called by
- 2
Reads stored settings via get_option(), cached per request but not free on a cold cache.
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 71.
Third-party callbacks on 'blog_details', 'site_details' 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
- cacheobject cache
wp_cache_get()called directly - optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters_deprecated()called directly - serializeserialisation
maybe_unserialize()one call below WP_Site::get_details()
Further down the call graph this can also reach 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 WP_Site::get_details() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$details !== false | 23 | wp_cache_get(), apply_filters() |
$details === false | 66–67 | wp_cache_get(), switch_to_blog(), get_object_vars(), get_option(), get_option(), get_option(), get_option(), restore_current_blog(), wp_cache_set(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 71 instructions, 23–67 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.
Hooks and filters fired · 2
2 hooks fire while WP_Site::get_details() runs, in this order:
- apply_filters( site_details )filterline 359 (+30 into the body)
Filters a site's extended properties.
Uses · 8
- wp_cache_get()Retrieves the cache contents from the cache by key and group.
- switch_to_blog()Switches the current blog.
- get_option()Retrieves an option value based on an option name.
- restore_current_blog()Restores the current blog, after calling switch_to_blog().
- wp_cache_set()Saves the data to the cache.
- apply_filters_deprecated()Fires functions attached to a deprecated filter hook.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- stdClass::__construct()
Used by · 2
- WP_Site::__get()Getter.
- WP_Site::__isset()Isset-er.
Source code
private function get_details() { $details = wp_cache_get( $this->blog_id, 'site-details' ); if ( false === $details ) { switch_to_blog( $this->blog_id ); // Create a raw copy of the object for backward compatibility with the filter below. $details = new stdClass(); foreach ( get_object_vars( $this ) as $key => $value ) { $details->$key = $value; } $details->blogname = get_option( 'blogname' ); $details->siteurl = get_option( 'siteurl' ); $details->post_count = get_option( 'post_count' ); $details->home = get_option( 'home' ); restore_current_blog(); wp_cache_set( $this->blog_id, $details, 'site-details' ); } /** This filter is documented in wp-includes/ms-blogs.php */ $details = apply_filters_deprecated( 'blog_details', array( $details ), '4.7.0', 'site_details' ); /** * Filters a site's extended properties. * * @since 4.6.0 * * @param stdClass $details The site details. */ $details = apply_filters( 'site_details', $details ); return $details; }Changelog
Introduced in 4.6.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-includes/class-wp-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.