get_blog_details

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

Description

(WP_Site|false) get_blog_details( (constant) $fields = null, (bool) $get_all = true );

Returns (WP_Site|false)

Blog details on success. False on failure.

Parameters (2)

0. $fields — Optional. (constant) => null: A blog ID, a blog slug, or an array of fields to query against. If not specified the current blog ID is used.
1. $get_all — Optional. (bool) => true: Whether to retrieve all details or only the details in the blogs table. Default is true.

Usage

if ( !function_exists( 'get_blog_details' ) ) { 
    require_once ABSPATH . WPINC . '/ms-blogs.php'; 
} 
  
// Optional. A blog ID, a blog slug, or an array of fields to query against. 
// If not specified the current blog ID is used. 
$fields = null; 
  
// Whether to retrieve all details or only the details in the blogs table. 
// Default is true. 
$get_all = true; 
  
// NOTICE! Understand what this does before running. 
$result = get_blog_details($fields, $get_all);

Defined (1)

The function is defined in the following location(s).

/wp-includes/ms-blogs.php

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 ( substr( $fields['domain'], 0, 4 ) == '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 ( substr( $fields['domain'], 0, 4 ) == '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 == true ? '' : 'short'; 
    $details = wp_cache_get( $blog_id . $all, 'blog-details' ); 
 
    if ( $details ) { 
        if ( ! is_object( $details ) ) { 
            if ( $details == -1 ) { 
                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 ( $details == -1 ) { 
                    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; 
    } 
 
    switch_to_blog( $blog_id ); 
    $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(); 
 
    /** 
     * Filters a blog's details. 
     * 
     * @since MU 
     * @deprecated 4.7.0 Use site_details 
     * 
     * @param object $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; 
}