get_blog_details( int|string|array $fields = null, bool $get_all = true ): WP_Site|false

Parameters

$fieldsint|string|arrayoptional

A blog ID, a blog slug, or an array of fields to query against. Defaults to the current blog ID.Default: null

$get_allbooloptional

Whether to retrieve all details or only the details in the blogs table. Default is true.Default: true

Return

WP_Site|false

Blog details on success. False on failure.

Hooks fired · 1

One hook fires while get_blog_details() runs, in this order:

1. 1
   do_action( blog_details )filter_deprecatedline 265 (+137 into the body)

   Filters a blog's details.

Uses · 13

• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• wp_cache_set()Saves the data to the cache.
• is_subdomain_install()Whether a subdomain configuration is enabled.
• get_current_blog_id()Retrieves the current site ID.
• get_id_from_blogname()Retrieves a site's ID given its (subdomain or directory) slug.
• wp_cache_delete()Removes the cache contents matching 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().
• apply_filters_deprecated()Fires functions attached to a deprecated filter hook.
• WP_Site::get_instance()Retrieves a site from the database by its ID.

Source

View on Trac ↗View on GitHub ↗

128function get_blog_details( $fields = null, $get_all = true ) {129	global $wpdb;130 131	if ( is_array( $fields ) ) {132		if ( isset( $fields['blog_id'] ) ) {133			$blog_id = $fields['blog_id'];134		} elseif ( isset( $fields['domain'] ) && isset( $fields['path'] ) ) {135			$key  = md5( $fields['domain'] . $fields['path'] );136			$blog = wp_cache_get( $key, 'blog-lookup' );137			if ( false !== $blog ) {138				return $blog;139			}140			if ( str_starts_with( $fields['domain'], 'www.' ) ) {141				$nowww = substr( $fields['domain'], 4 );142				$blog  = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) AND path = %s ORDER BY CHAR_LENGTH(domain) DESC", $nowww, $fields['domain'], $fields['path'] ) );143			} else {144				$blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s AND path = %s", $fields['domain'], $fields['path'] ) );145			}146			if ( $blog ) {147				wp_cache_set( $blog->blog_id . 'short', $blog, 'blog-details' );148				$blog_id = $blog->blog_id;149			} else {150				return false;151			}152		} elseif ( isset( $fields['domain'] ) && is_subdomain_install() ) {153			$key  = md5( $fields['domain'] );154			$blog = wp_cache_get( $key, 'blog-lookup' );155			if ( false !== $blog ) {156				return $blog;157			}158			if ( str_starts_with( $fields['domain'], 'www.' ) ) {159				$nowww = substr( $fields['domain'], 4 );160				$blog  = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) ORDER BY CHAR_LENGTH(domain) DESC", $nowww, $fields['domain'] ) );161			} else {162				$blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s", $fields['domain'] ) );163			}164			if ( $blog ) {165				wp_cache_set( $blog->blog_id . 'short', $blog, 'blog-details' );166				$blog_id = $blog->blog_id;167			} else {168				return false;169			}170		} else {171			return false;172		}173	} else {174		if ( ! $fields ) {175			$blog_id = get_current_blog_id();176		} elseif ( ! is_numeric( $fields ) ) {177			$blog_id = get_id_from_blogname( $fields );178		} else {179			$blog_id = $fields;180		}181	}182 183	$blog_id = (int) $blog_id;184 185	$all     = $get_all ? '' : 'short';186	$details = wp_cache_get( $blog_id . $all, 'blog-details' );187 188	if ( $details ) {189		if ( ! is_object( $details ) ) {190			if ( -1 === $details ) {191				return false;192			} else {193				// Clear old pre-serialized objects. Cache clients do better with that.194				wp_cache_delete( $blog_id . $all, 'blog-details' );195				unset( $details );196			}197		} else {198			return $details;199		}200	}201 202	// Try the other cache.203	if ( $get_all ) {204		$details = wp_cache_get( $blog_id . 'short', 'blog-details' );205	} else {206		$details = wp_cache_get( $blog_id, 'blog-details' );207		// If short was requested and full cache is set, we can return.

History

Introduced in MU (3.0.0). Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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-blogs.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.