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

Retrieves site data given a site ID or site object.

Contents

Description 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 Parameters

$site

(WP_Site|int|null) (Optional) Site to retrieve. Default is the current site.

Default value: null

Top ↑

Return Return

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

Top ↑

Source Source

File: wp-includes/ms-site.php

293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
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;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
4.6.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
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/class-wp-network.php: WP_Network::get_main_site_id()

Returns the main site ID for the network.
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-site-query.php: WP_Site_Query::get_sites()

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

Delete a site.
wp-includes/user.php: is_user_member_of_blog()

Find out whether a user is a member of a given blog.
wp-includes/ms-deprecated.php: wp_get_sites()

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

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

Adds a user to a blog.
wp-includes/ms-load.php: ms_site_check()

Checks status of current blog.
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()

Get 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()

Get a full blog URL, given a blog id.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_multisite_getUsersBlogs()

Private function for retrieving a users blogs for multisite setups
Show 14 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

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