wpseek.com
A WordPress-centric search engine for devs and theme authors



is_user_member_of_blog › WordPress Function

Sincen/a
Deprecatedn/a
is_user_member_of_blog ( $user_id = 0, $blog_id = 0 )
Parameters: (2)
  • (int) $user_id Optional. The unique ID of the user. Defaults to the current user.
    Required: No
    Default:
  • (int) $blog_id Optional. ID of the blog to check. Defaults to the current site.
    Required: No
    Default:
Returns:
  • (bool)
Defined at:
Codex:
Change Log:
  • 7.1.0

Finds out whether a user is a member of a given blog.



Source

function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
	global $wpdb;

	$user_id = (int) $user_id;
	$blog_id = (int) $blog_id;

	if ( empty( $user_id ) ) {
		$user_id = get_current_user_id();
	}

	/*
	 * Technically not needed, but does save calls to get_site() and get_user_meta()
	 * in the event that the function is called when a user isn't logged in.
	 */
	if ( empty( $user_id ) ) {
		return false;
	} else {
		$user = get_userdata( $user_id );
		if ( ! $user instanceof WP_User ) {
			return false;
		}
	}

	if ( ! is_multisite() ) {
		return true;
	}

	if ( empty( $blog_id ) ) {
		$blog_id = get_current_blog_id();
	}

	$blog = get_site( $blog_id );

	if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) {
		return false;
	}

	if ( 1 === $blog_id ) {
		$capabilities_key = $wpdb->base_prefix . 'capabilities';
	} else {
		$capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
	}

	$has_cap   = get_user_meta( $user_id, $capabilities_key, true );
	$is_member = is_array( $has_cap );

	/**
	 * Filters whether the user is a member of a given blog.
	 *
	 * This filter only runs when the user and blog have both been resolved
	 * to valid records on a multisite installation; it is not invoked for
	 * logged-out requests, unknown users, or archived/spammed/deleted sites.
	 *
	 * @since 7.1.0
	 *
	 * @param bool $is_member Whether the user is a member of the blog.
	 * @param int  $user_id   The user ID being checked.
	 * @param int  $blog_id   The blog ID being checked.
	 */
	return (bool) apply_filters( 'is_user_member_of_blog', $is_member, $user_id, $blog_id );
}