Contents

Code Reference Classes BP_Members_Suggestions BP_Members_Suggestions::get_suggestions()

BP_Members_Suggestions::get_suggestions()

Find and return a list of username suggestions that match the query.

Description

Return

(array|WP_Error) Array of results. If there were problems, returns a WP_Error object.

Source

File: bp-core/classes/class-bp-members-suggestions.php

84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
public function get_suggestions() {
    $user_query = array(
        'count_total'     => '',  // Prevents total count.
        'populate_extras' => false,
        'type'            => 'alphabetical',
 
        'page'            => 1,
        'per_page'        => $this->args['limit'],
        'search_terms'    => $this->args['term'],
        'search_wildcard' => 'right',
    );
 
    // Only return matches of friends of this user.
    if ( $this->args['only_friends'] && is_user_logged_in() ) {
        $user_query['user_id'] = get_current_user_id();
    }
 
    /**
     * Filters the members suggestions query args.
     *
     * @since BuddyPress 2.1.0
     *
     * @param array                  $user_query Array of query arguments.
     * @param BP_Members_Suggestions $this       Current BP_Members_Suggestions instance.
     */
    $user_query = apply_filters( 'bp_members_suggestions_query_args', $user_query, $this );
    if ( is_wp_error( $user_query ) ) {
        return $user_query;
    }
 
 
    $user_query = new BP_User_Query( $user_query );
    $results    = array();
 
    foreach ( $user_query->results as $user ) {
        $result          = new stdClass();
        $result->ID      = $user->user_nicename;
        $result->image   = bp_core_fetch_avatar( array( 'html' => false, 'item_id' => $user->ID ) );
        $result->name    = bp_core_get_user_displayname( $user->ID );
        $result->user_id = $user->ID;
 
        $results[] = $result;
    }
 
    /**
     * Filters the members suggestions results.
     *
     * @since BuddyPress 2.1.0
     *
     * @param array                  $results Array of users to suggest.
     * @param BP_Members_Suggestions $this    Current BP_Members_Suggestions instance.
     */
    return apply_filters( 'bp_members_suggestions_get_suggestions', $results, $this );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.1.0 Introduced.

Uses

Uses
Uses Description
bp-xprofile/bp-xprofile-functions.php: bp_activity_get_user_mentionname()

Determine a user’s “mentionname”, the name used for that user in @-mentions.
bp-members/bp-members-functions.php: bp_core_get_user_displayname()

Fetch the display name for a user.
bp-core/classes/class-bp-user-query.php: BP_User_Query::__construct()

Constructor.
bp-core/classes/class-bp-members-suggestions.php: bp_members_suggestions_query_args

Filters the members suggestions query args.
bp-core/classes/class-bp-members-suggestions.php: bp_members_suggestions_get_suggestions

Filters the members suggestions results.
bp-core/bp-core-avatars.php: bp_core_fetch_avatar()

Get an avatar for a BuddyPress object.
Show 1 more use Hide more uses

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.