This method has been deprecated. Use BP_User_Query() instead.

BP_Core_User::get_users( string $type, int $limit, int $page = 1, int $user_id, mixed $include = false, string|bool $search_terms = false, bool $populate_extras = true, mixed $exclude = false, string|bool $meta_key = false, string|bool $meta_value = false )

Get a list of users that match the query parameters.

Description

Since BuddyPress 1.7, use BP_User_Query instead.

See also

BP_User_Query: for a description of parameters, most of which are used there in the same way.

Parameters

$type

(Required) See BP_User_Query.

$limit

(Required) See BP_User_Query. Default: 0.

$page

(Optional) See BP_User_Query. Default: 1.

Default value: 1

$user_id

(Required) See BP_User_Query. Default: 0.

$include

(Optional) See BP_User_Query. Default: false.

Default value: false

$search_terms

(Optional) See BP_User_Query. Default: false.

Default value: false

$populate_extras

(Optional) See BP_User_Query. Default: true.

Default value: true

$exclude

(Optional) See BP_User_Query. Default: false.

Default value: false

$meta_key

(Optional) See BP_User_Query. Default: false.

Default value: false

$meta_value

(Optional) See BP_User_Query. Default: false.

Default value: false

Return

(false|array)

'total_users'
(int) Total number of users matched by query params.
'paged_users'
(array) The current page of users matched by query params.

Source

File: bp-core/classes/class-bp-core-user.php

public static function get_users( $type, $limit = 0, $page = 1, $user_id = 0, $include = false, $search_terms = false, $populate_extras = true, $exclude = false, $meta_key = false, $meta_value = false ) {
    global $wpdb;
 
    _deprecated_function( __METHOD__, '1.7', 'BP_User_Query' );
 
    $bp = buddypress();
 
    $sql = array();
 
    $sql['select_main'] = "SELECT DISTINCT u.ID as id, u.user_registered, u.user_nicename, u.user_login, u.display_name, u.user_email";
 
    if ( 'active' == $type || 'online' == $type || 'newest' == $type  ) {
        $sql['select_active'] = ", um.meta_value as last_activity";
    }
 
    if ( 'popular' == $type ) {
        $sql['select_popular'] = ", um.meta_value as total_friend_count";
    }
 
    if ( 'alphabetical' == $type ) {
        $sql['select_alpha'] = ", pd.value as fullname";
    }
 
    if ( $meta_key ) {
        $sql['select_meta'] = ", umm.meta_key";
 
        if ( $meta_value ) {
            $sql['select_meta'] .= ", umm.meta_value";
        }
    }
 
    $sql['from'] = "FROM {$wpdb->users} u LEFT JOIN {$wpdb->usermeta} um ON um.user_id = u.ID";
 
    // We search against xprofile fields, so we must join the table.
    if ( $search_terms && bp_is_active( 'xprofile' ) ) {
        $sql['join_profiledata_search'] = "LEFT JOIN {$bp->profile->table_name_data} spd ON u.ID = spd.user_id";
    }
 
    // Alphabetical sorting is done by the xprofile Full Name field.
    if ( 'alphabetical' == $type ) {
        $sql['join_profiledata_alpha'] = "LEFT JOIN {$bp->profile->table_name_data} pd ON u.ID = pd.user_id";
    }
 
    if ( $meta_key ) {
        $sql['join_meta'] = "LEFT JOIN {$wpdb->usermeta} umm ON umm.user_id = u.ID";
    }
 
    $sql['where'] = 'WHERE ' . bp_core_get_status_sql( 'u.' );
 
    if ( 'active' == $type || 'online' == $type || 'newest' == $type ) {
        $sql['where_active'] = $wpdb->prepare( "AND um.meta_key = %s", bp_get_user_meta_key( 'last_activity' ) );
    }
 
    if ( 'popular' == $type ) {
        $sql['where_popular'] = $wpdb->prepare( "AND um.meta_key = %s", bp_get_user_meta_key( 'total_friend_count' ) );
    }
 
    if ( 'online' == $type ) {
        $sql['where_online'] = "AND DATE_ADD( um.meta_value, INTERVAL 5 MINUTE ) >= UTC_TIMESTAMP()";
    }
 
    if ( 'alphabetical' == $type ) {
        $sql['where_alpha'] = "AND pd.field_id = " . bp_xprofile_nickname_field_id();
    }
 
    if ( !empty( $exclude ) ) {
        $exclude              = implode( ',', wp_parse_id_list( $exclude ) );
        $sql['where_exclude'] = "AND u.ID NOT IN ({$exclude})";
    }
 
    // Passing an $include value of 0 or '0' will necessarily result in an empty set
    // returned. The default value of false will hit the 'else' clause.
    if ( 0 === $include || '0' === $include ) {
        $sql['where_users'] = "AND 0 = 1";
    } else {
        if ( !empty( $include ) ) {
            $include = implode( ',',  wp_parse_id_list( $include ) );
            $sql['where_users'] = "AND u.ID IN ({$include})";
        } elseif ( !empty( $user_id ) && bp_is_active( 'friends' ) ) {
            $friend_ids = friends_get_friend_user_ids( $user_id );
 
            if ( !empty( $friend_ids ) ) {
                $friend_ids = implode( ',', wp_parse_id_list( $friend_ids ) );
                $sql['where_friends'] = "AND u.ID IN ({$friend_ids})";
 
            // User has no friends, return false since there will be no users to fetch.
            } else {
                return false;
            }
        }
    }
 
    if ( !empty( $search_terms ) && bp_is_active( 'xprofile' ) ) {
        $search_terms_like        = '%' . bp_esc_like( $search_terms ) . '%';
        $sql['where_searchterms'] = $wpdb->prepare( "AND spd.value LIKE %s", $search_terms_like );
    }
 
    if ( !empty( $meta_key ) ) {
        $sql['where_meta'] = $wpdb->prepare( " AND umm.meta_key = %s", $meta_key );
 
        // If a meta value is provided, match it.
        if ( $meta_value ) {
            $sql['where_meta'] .= $wpdb->prepare( " AND umm.meta_value = %s", $meta_value );
        }
    }
 
    switch ( $type ) {
        case 'active': case 'online': default:
            $sql[] = "ORDER BY um.meta_value DESC";
            break;
        case 'newest':
            $sql[] = "ORDER BY u.ID DESC";
            break;
        case 'alphabetical':
            $sql[] = "ORDER BY pd.value ASC";
            break;
        case 'random':
            $sql[] = "ORDER BY rand()";
            break;
        case 'popular':
            $sql[] = "ORDER BY CONVERT(um.meta_value, SIGNED) DESC";
            break;
    }
 
    if ( !empty( $limit ) && !empty( $page ) ) {
        $sql['pagination'] = $wpdb->prepare( "LIMIT %d, %d", intval( ( $page - 1 ) * $limit), intval( $limit ) );
    }
 
    /**
     * Filters the SQL used to query for paged users.
     *
     * @since BuddyPress 1.2.6
     *
     * @param string $value Concatenated SQL statement for the query.
     * @param array  $sql   Array of SQL statement parts for the query.
     */
    $paged_users_sql = apply_filters( 'bp_core_get_paged_users_sql', join( ' ', (array) $sql ), $sql );
    $paged_users     = $wpdb->get_results( $paged_users_sql );
 
    // Re-jig the SQL so we can get the total user count.
    unset( $sql['select_main'] );
 
    if ( !empty( $sql['select_active'] ) ) {
        unset( $sql['select_active'] );
    }
 
    if ( !empty( $sql['select_popular'] ) ) {
        unset( $sql['select_popular'] );
    }
 
    if ( !empty( $sql['select_alpha'] ) ) {
        unset( $sql['select_alpha'] );
    }
 
    if ( !empty( $sql['pagination'] ) ) {
        unset( $sql['pagination'] );
    }
 
    array_unshift( $sql, "SELECT COUNT(u.ID)" );
 
    /**
     * Filters the SQL used to query for total users.
     *
     * @since BuddyPress 1.2.6
     *
     * @param string $value Concatenated SQL statement for the query.
     * @param array  $sql   Array of SQL statement parts for the query.
     */
    $total_users_sql = apply_filters( 'bp_core_get_total_users_sql', join( ' ', (array) $sql ), $sql );
    $total_users     = $wpdb->get_var( $total_users_sql );
 
    /**
     * Lets fetch some other useful data in a separate queries, this will be faster than querying the data for every user in a list.
     * We can't add these to the main query above since only users who have this information will be returned (since the much of the data is in usermeta and won't support any type of directional join).
     */
    if ( !empty( $populate_extras ) ) {
        $user_ids = array();
 
        foreach ( (array) $paged_users as $user ) {
            $user_ids[] = $user->id;
        }
 
        // Add additional data to the returned results.
        $paged_users = BP_Core_User::get_user_extras( $paged_users, $user_ids, $type );
    }
 
    return array( 'users' => $paged_users, 'total' => $total_users );
}

Expand full source code Collapse full source code

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_nickname_field_id()	Get the field id of the nick name field, fallback to default fullname field
bp-friends/bp-friends-functions.php: friends_get_friend_user_ids()	Get the IDs of a given user’s friends.
bp-core/bp-core-wpabstraction.php: bp_core_get_status_sql()	Get SQL chunk for filtering spam users from member queries.
bp-core/bp-core-template.php: bp_is_active()	Check whether a given component (or feature of a component) is active.
bp-core/classes/class-bp-core-user.php: BP_Core_User::get_user_extras()	Fetch extra user information, such as friend count and last profile update message.
bp-core/classes/class-bp-core-user.php: bp_core_get_paged_users_sql	Filters the SQL used to query for paged users.
bp-core/classes/class-bp-core-user.php: bp_core_get_total_users_sql	Filters the SQL used to query for total users.
bp-core/bp-core-functions.php: bp_get_user_meta_key()	Get the meta_key for a given piece of user metadata
bp-core/bp-core-functions.php: bp_esc_like()	Escape special characters in a SQL LIKE clause.

Show 5 more uses Hide more uses

Used By
Used By	Description
bp-members/bp-members-functions.php: bp_core_get_users()	Fetch an array of users based on the parameters passed.
bp-friends/bp-friends-template.php: bp_friends_random_members()	Pull up a group of random members, and display some profile data about them.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.