Retrieves site data given a site ID or site object.
Description
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.
Parameters
$site
WP_Site|int|nulloptional- Site to retrieve. Default is the current site.
Default:
null
Source
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;
}
Hooks
- apply_filters( ‘get_site’,
WP_Site $_site ) Fires after a site is retrieved.
Changelog
Version | Description |
---|---|
4.6.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.