get_site

Retrieves site data given a site ID or site object.

Description

(WP_Site|null) get_site( (null) $site = null );

Site data will be cached and returned after being passed through a filter. If the provided site is empty, the current site global will be used.

Returns (WP_Site|null)

The site object or null if not found.

Parameters (1)

0. $site — Optional. (null) => null: Site to retrieve. Default is the current site.

Usage

if ( !function_exists( 'get_site' ) ) { 
    require_once ABSPATH . WPINC . '/ms-blogs.php'; 
} 
  
// Optional. Site to retrieve. Default is the current site. 
$site = null; 
  
// NOTICE! Understand what this does before running. 
$result = get_site($site);

Defined (1)

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

/wp-includes/ms-blogs.php

function get_site( $site = null ) { 
    if ( empty( $site ) ) { 
        $site = get_current_blog_id(); 
    } 
 
    if ( $site instanceof WP_Site ) { 
        $_site = $site; 
    } elseif ( is_object( $site ) ) { 
        $_site = new WP_Site( $site ); 
    } else { 
        $_site = WP_Site::get_instance( $site ); 
    } 
 
    if ( ! $_site ) { 
        return null; 
    } 
 
    /** 
     * Fires after a site is retrieved. 
     * 
     * @since 4.6.0 
     * 
     * @param WP_Site $_site Site data. 
     */ 
    $_site = apply_filters( 'get_site', $_site ); 
 
    return $_site; 
}