get_blog_details() – Function | Developer.WordPress.org

Retrieves the details for a blog from the blogs table and blog options.

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.

Source

function get_blog_details( $fields = null, $get_all = true ) {
	global $wpdb;

	if ( is_array( $fields ) ) {
		if ( isset( $fields['blog_id'] ) ) {
			$blog_id = $fields['blog_id'];
		} elseif ( isset( $fields['domain'] ) && isset( $fields['path'] ) ) {
			$key  = md5( $fields['domain'] . $fields['path'] );
			$blog = wp_cache_get( $key, 'blog-lookup' );
			if ( false !== $blog ) {
				return $blog;
			}
			if ( str_starts_with( $fields['domain'], 'www.' ) ) {
				$nowww = substr( $fields['domain'], 4 );
				$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'] ) );
			} else {
				$blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s AND path = %s", $fields['domain'], $fields['path'] ) );
			}
			if ( $blog ) {
				wp_cache_set( $blog->blog_id . 'short', $blog, 'blog-details' );
				$blog_id = $blog->blog_id;
			} else {
				return false;
			}
		} elseif ( isset( $fields['domain'] ) && is_subdomain_install() ) {
			$key  = md5( $fields['domain'] );
			$blog = wp_cache_get( $key, 'blog-lookup' );
			if ( false !== $blog ) {
				return $blog;
			}
			if ( str_starts_with( $fields['domain'], 'www.' ) ) {
				$nowww = substr( $fields['domain'], 4 );
				$blog  = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) ORDER BY CHAR_LENGTH(domain) DESC", $nowww, $fields['domain'] ) );
			} else {
				$blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s", $fields['domain'] ) );
			}
			if ( $blog ) {
				wp_cache_set( $blog->blog_id . 'short', $blog, 'blog-details' );
				$blog_id = $blog->blog_id;
			} else {
				return false;
			}
		} else {
			return false;
		}
	} else {
		if ( ! $fields ) {
			$blog_id = get_current_blog_id();
		} elseif ( ! is_numeric( $fields ) ) {
			$blog_id = get_id_from_blogname( $fields );
		} else {
			$blog_id = $fields;
		}
	}

	$blog_id = (int) $blog_id;

	$all     = $get_all ? '' : 'short';
	$details = wp_cache_get( $blog_id . $all, 'blog-details' );

	if ( $details ) {
		if ( ! is_object( $details ) ) {
			if ( -1 === $details ) {
				return false;
			} else {
				// Clear old pre-serialized objects. Cache clients do better with that.
				wp_cache_delete( $blog_id . $all, 'blog-details' );
				unset( $details );
			}
		} else {
			return $details;
		}
	}

	// Try the other cache.
	if ( $get_all ) {
		$details = wp_cache_get( $blog_id . 'short', 'blog-details' );
	} else {
		$details = wp_cache_get( $blog_id, 'blog-details' );
		// If short was requested and full cache is set, we can return.
		if ( $details ) {
			if ( ! is_object( $details ) ) {
				if ( -1 === $details ) {
					return false;
				} else {
					// Clear old pre-serialized objects. Cache clients do better with that.
					wp_cache_delete( $blog_id, 'blog-details' );
					unset( $details );
				}
			} else {
				return $details;
			}
		}
	}

	if ( empty( $details ) ) {
		$details = WP_Site::get_instance( $blog_id );
		if ( ! $details ) {
			// Set the full cache.
			wp_cache_set( $blog_id, -1, 'blog-details' );
			return false;
		}
	}

	if ( ! $details instanceof WP_Site ) {
		$details = new WP_Site( $details );
	}

	if ( ! $get_all ) {
		wp_cache_set( $blog_id . $all, $details, 'blog-details' );
		return $details;
	}

	$switched_blog = false;

	if ( get_current_blog_id() !== $blog_id ) {
		switch_to_blog( $blog_id );
		$switched_blog = true;
	}

	$details->blogname   = get_option( 'blogname' );
	$details->siteurl    = get_option( 'siteurl' );
	$details->post_count = get_option( 'post_count' );
	$details->home       = get_option( 'home' );

	if ( $switched_blog ) {
		restore_current_blog();
	}

	/**
	 * Filters a blog's details.
	 *
	 * @since MU (3.0.0)
	 * @deprecated 4.7.0 Use 'site_details' instead.
	 *
	 * @param WP_Site $details The blog details.
	 */
	$details = apply_filters_deprecated( 'blog_details', array( $details ), '4.7.0', 'site_details' );

	wp_cache_set( $blog_id . $all, $details, 'blog-details' );

	$key = md5( $details->domain . $details->path );
	wp_cache_set( $key, $details, 'blog-lookup' );

	return $details;
}

View all references View on Trac View on GitHub

Hooks

apply_filters_deprecated( ‘blog_details’, WP_Site $details ): Filters a blog’s details.

Uses	Description
apply_filters_deprecated()`wp-includes/plugin.php`	Fires functions attached to a deprecated filter hook.
WP_Site::get_instance()`wp-includes/class-wp-site.php`	Retrieves a site from the database by its ID.
WP_Site::__construct()`wp-includes/class-wp-site.php`	Creates a new WP_Site object.
wp_cache_set()`wp-includes/cache.php`	Saves the data to the cache.
wp_cache_delete()`wp-includes/cache.php`	Removes the cache contents matching key and group.
is_subdomain_install()`wp-includes/ms-load.php`	Whether a subdomain configuration is enabled.
switch_to_blog()`wp-includes/ms-blogs.php`	Switches the current blog.
restore_current_blog()`wp-includes/ms-blogs.php`	Restores the current blog, after calling switch_to_blog() .
get_id_from_blogname()`wp-includes/ms-blogs.php`	Retrieves a site’s ID given its (subdomain or directory) slug.
wpdb::get_row()`wp-includes/class-wpdb.php`	Retrieves one row from the database.
wp_cache_get()`wp-includes/cache.php`	Retrieves the cache contents from the cache by key and group.
get_current_blog_id()`wp-includes/load.php`	Retrieves the current site ID.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.
wpdb::prepare()`wp-includes/class-wpdb.php`	Prepares a SQL query for safe execution.

Show 9 more Show less

Changelog

Version	Description
MU (3.0.0)	Introduced.

User Contributed Notes

Skip to note 3 content

西門正 Code Guy 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Since there is practical needs about getting additional information from multisite like this post, it might worth to note here of what get_blog_details() is returning. It could save people, who is not familiar with WordPress, the time from trying.

By default, the get_blog_details() only returns the following details of the site.
- blogname
- siteurl
- post_count
- home
If in case, need to get other information such as blog description of one of the sites. May achieve by using

get_blog_option( $blog_id, 'blogdescription' );

Reference: get_blog_option()
Log in to add feedback
Skip to note 4 content

Márcio Duarte 3 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

Note that get_blog_details was deprecated in favor of get_site. Reference.

Log in to add feedback

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

In this article

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes

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

In this article

Parameters

Return

Source

Hooks

Related

Changelog

User Contributed Notes