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

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

(Optional) Site to retrieve. Default is the current site.

Default value: null

Return

(WP_Site|null) The site object or null if not found.

Source

File: wp-includes/ms-site.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 WP-4.6.0
	 *
	 * @param WP_Site $_site Site data.
	 */
	$_site = apply_filters( 'get_site', $_site );

	return $_site;
}

Expand Source Code View on GitHub

Related

Used By

Used By
Used By Description
wp-includes/ms-functions.php: wpmu_new_site_admin_notification()

Notifies the Multisite network administrator that a new site was created.
wp-includes/ms-site.php: wp_initialize_site()

Runs the initialization routine for a given site.
wp-includes/ms-site.php: wp_uninitialize_site()

Runs the uninitialization routine for a given site.
wp-includes/ms-site.php: wp_insert_site()

Inserts a new site into the database.
wp-includes/ms-site.php: wp_update_site()

Updates a site in the database.
wp-includes/ms-site.php: wp_delete_site()

Deletes a site from the database.
wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php: WP_REST_Users_Controller::create_item()

Creates a single user.
wp-includes/class-wp-network.php: WP_Network::get_main_site_id()

Returns the main site ID for the network.
wp-includes/ms-load.php: ms_site_check()

Checks status of current blog.
wp-includes/ms-deprecated.php: wp_get_sites()

Return an array of sites for a network or networks.
wp-includes/ms-deprecated.php: get_dashboard_blog()

Get the “dashboard blog”, the blog where users without a blog edit their profile data.
wp-includes/ms-blogs.php: get_blog_status()

Gets a blog details field.
wp-includes/ms-site.php: clean_blog_cache()

Clean the blog cache
wp-includes/ms-blogs.php: get_blogaddress_by_id()

Gets a full blog URL, given a blog ID.
wp-includes/user.php: is_user_member_of_blog()

Finds out whether a user is a member of a given blog.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_multisite_getUsersBlogs()

Private function for retrieving a users blogs for multisite setups.
wp-includes/class-wp-site-query.php: WP_Site_Query::get_sites()

Retrieves a list of sites matching the query vars.
wp-includes/ms-functions.php: get_active_blog_for_user()

Gets one of a user’s active blogs.
wp-includes/ms-functions.php: add_user_to_blog()

Adds a user to a blog, along with specifying the user’s role.
wp-admin/includes/ms.php: wpmu_delete_blog()

Deletes a site.
Show 15 more used by Hide more used by

Changelog

Changelog
Version Description
4.6.0 Introduced.