get_blogs_of_user( int $user_id, bool $all = false ): object[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$user_idint

User ID

$allbooloptional

Whether to retrieve all sites, or only sites that are not marked as deleted, archived, or spam.Default: false

Return value

object[]

A list of the user's sites. An empty array if the user doesn't exist or belongs to no sites.

Performance profile

How much work a call to get_blogs_of_user() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

8–70

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 160.

Plugin surface

2 hooks

Third-party callbacks on 'pre_get_blogs_of_user', 'get_blogs_of_user' run inside this call, and their cost is not bounded by anything here.

Called by

13

13 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below get_blogs_of_user()
• serializeserialisationmaybe_unserialize()one call below get_blogs_of_user()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_blogs_of_user() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while get_blogs_of_user() runs, in this order:

1. 1
   apply_filters( pre_get_blogs_of_user )filterline 1057 (+23 into the body)

   Filters the list of a user's sites before it is populated.

2. 2
   apply_filters( get_blogs_of_user )filterline 1148 (+114 into the body)

   Filters the list of sites a user belongs to.

Uses · 9

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_user_meta()Retrieves user meta field for a user.
• is_multisite()Determines whether Multisite is enabled.
• get_current_blog_id()Retrieves the current site ID.
• get_option()Retrieves an option value based on an option name.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• get_sites()Retrieves a list of sites matching requested arguments.
• stdClass::__construct()

Used by · 13

• WP_Admin_Bar::initialize()Initializes the admin bar.
• WP_MS_Users_List_Table::column_blogs()Handles the sites column output.
• _access_denied_splash()Displays an access denied message when a user tries to view a site's dashboard they do not have access to.
• choose_primary_blog()Handles the display of choosing a user's primary site.
• confirm_delete_users()
• get_active_blog_for_user()Gets one of a user's active blogs.
• get_dashboard_url()Retrieves the URL to the user's dashboard.
• get_most_recent_post_of_user()Gets a user's most recent post.
• remove_user_from_blog()Removes a user from a blog.
• signup_another_blog()Shows a form for returning users to sign up for another site.
• wp_dashboard_quick_press()Displays the Quick Draft widget.
• wp_xmlrpc_server::wp_getUsersBlogs()Retrieves the blogs of the user.

Source code

View on Trac ↗View on GitHub ↗

1034function get_blogs_of_user( $user_id, $all = false ) {1035	global $wpdb;1036 1037	$user_id = (int) $user_id;1038 1039	// Logged out users can't have sites.1040	if ( empty( $user_id ) ) {1041		return array();1042	}1043 1044	/**1045	 * Filters the list of a user's sites before it is populated.1046	 *1047	 * Returning a non-null value from the filter will effectively short circuit1048	 * get_blogs_of_user(), returning that value instead.1049	 *1050	 * @since 4.6.01051	 *1052	 * @param null|object[] $sites   An array of site objects of which the user is a member.1053	 * @param int           $user_id User ID.1054	 * @param bool          $all     Whether the returned array should contain all sites, including1055	 *                               those marked 'deleted', 'archived', or 'spam'. Default false.1056	 */1057	$sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );1058 1059	if ( null !== $sites ) {1060		return $sites;1061	}1062 1063	$keys = get_user_meta( $user_id );1064	if ( empty( $keys ) ) {1065		return array();1066	}1067 1068	if ( ! is_multisite() ) {1069		$site_id                        = get_current_blog_id();1070		$sites                          = array( $site_id => new stdClass() );1071		$sites[ $site_id ]->userblog_id = $site_id;1072		$sites[ $site_id ]->blogname    = get_option( 'blogname' );1073		$sites[ $site_id ]->domain      = '';1074		$sites[ $site_id ]->path        = '';1075		$sites[ $site_id ]->site_id     = 1;1076		$sites[ $site_id ]->siteurl     = get_option( 'siteurl' );1077		$sites[ $site_id ]->archived    = 0;1078		$sites[ $site_id ]->spam        = 0;1079		$sites[ $site_id ]->deleted     = 0;1080		return $sites;1081	}1082 1083	$site_ids = array();1084 1085	if ( isset( $keys[ $wpdb->base_prefix . 'capabilities' ] ) && defined( 'MULTISITE' ) ) {1086		$site_ids[] = 1;1087		unset( $keys[ $wpdb->base_prefix . 'capabilities' ] );1088	}1089 1090	$keys = array_keys( $keys );1091 1092	foreach ( $keys as $key ) {1093		if ( ! str_ends_with( $key, 'capabilities' ) ) {1094			continue;1095		}1096		if ( $wpdb->base_prefix && ! str_starts_with( $key, $wpdb->base_prefix ) ) {1097			continue;1098		}1099		$site_id = str_replace( array( $wpdb->base_prefix, '_capabilities' ), '', $key );1100		if ( ! is_numeric( $site_id ) ) {1101			continue;1102		}1103 1104		$site_ids[] = (int) $site_id;1105	}1106 1107	$sites = array();1108 1109	if ( ! empty( $site_ids ) ) {1110		$args = array(1111			'number'   => '',1112			'site__in' => $site_ids,1113		);

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.