WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_site()

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

In this article

Back to top

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

$siteWP_Site|int|nulloptional
Site to retrieve. Default is the current site.

Default:null

Return

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

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;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_site’, WP_Site $_site )

Fires after a site is retrieved.

UsesDescription
get_current_blog_id()wp-includes/load.php

Retrieves the current site ID.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Used byDescription
wp_initialize_site()wp-includes/ms-site.php

Runs the initialization routine for a given site.

wp_uninitialize_site()wp-includes/ms-site.php

Runs the uninitialization routine for a given site.

wp_insert_site()wp-includes/ms-site.php

Inserts a new site into the database.

wp_update_site()wp-includes/ms-site.php

Updates a site in the database.

wp_delete_site()wp-includes/ms-site.php

Deletes a site from the database.

wpmu_delete_blog()wp-admin/includes/ms.php

Deletes a site.

wp_lostpassword_url()wp-includes/general-template.php

Returns the URL that allows the user to reset the lost password.

wp_get_sites()wp-includes/ms-deprecated.php

Return an array of sites for a network or networks.

ms_site_check()wp-includes/ms-load.php

Checks status of current blog.

get_dashboard_blog()wp-includes/ms-deprecated.php

Get the “dashboard blog”, the blog where users without a blog edit their profile data.

get_blog_status()wp-includes/ms-blogs.php

Gets a blog details field.

clean_blog_cache()wp-includes/ms-site.php

Clean the blog cache

get_blogaddress_by_id()wp-includes/ms-blogs.php

Gets a full site URL, given a site ID.

Show 8 moreShow less

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.