Contents

Code Reference Classes BP_User_Query BP_User_Query::__construct()

BP_User_Query::__construct( string|array|null $query = null )

Constructor.

Description

Parameters

$query

(Optional) See BP_User_Query.

Default value: null

Source

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

150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
public function __construct( $query = null ) {
 
    // Store the raw query vars for later access.
    $this->query_vars_raw = $query;
 
    // Allow extending classes to register action/filter hooks.
    $this->setup_hooks();
 
    if ( ! empty( $this->query_vars_raw ) ) {
        $this->query_vars = wp_parse_args( $this->query_vars_raw, array(
            'type'                => 'newest',
            'per_page'            => 0,
            'page'                => 1,
            'user_id'             => 0,
            'search_terms'        => false,
            'search_wildcard'     => 'both',
            'include'             => false,
            'exclude'             => false,
            'user_ids'            => false,
            'member_type'         => '',
            'member_type__in'     => '',
            'member_type__not_in' => '',
            'meta_key'            => false,
            'meta_value'          => false,
            'xprofile_query'      => false,
            'populate_extras'     => true,
            'count_total'         => 'count_query'
        ) );
 
        /**
         * Fires before the construction of the BP_User_Query query.
         *
         * @since BuddyPress 1.7.0
         *
         * @param BP_User_Query $this Current instance of the BP_User_Query. Passed by reference.
         */
        do_action_ref_array( 'bp_pre_user_query_construct', array( &$this ) );
 
        // Get user ids
        // If the user_ids param is present, we skip the query.
        if ( false !== $this->query_vars['user_ids'] ) {
            $this->user_ids = wp_parse_id_list( $this->query_vars['user_ids'] );
        } else {
            $this->prepare_user_ids_query();
            $this->do_user_ids_query();
        }
    }
 
    // Bail if no user IDs were found.
    if ( empty( $this->user_ids ) ) {
        return;
    }
 
    // Fetch additional data. First, using WP_User_Query.
    $this->do_wp_user_query();
 
    // Get BuddyPress specific user data.
    $this->populate_extras();
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.7.0 Introduced.

Uses

Uses
Uses Description
bp-core/classes/class-bp-user-query.php: BP_User_Query::populate_extras()

Perform a database query to populate any extra metadata we might need.
bp-core/classes/class-bp-user-query.php: BP_User_Query::setup_hooks()

Allow extending classes to set up action/filter hooks.
bp-core/classes/class-bp-user-query.php: BP_User_Query::prepare_user_ids_query()

Prepare the query for user_ids.
bp-core/classes/class-bp-user-query.php: BP_User_Query::do_user_ids_query()

Query for IDs of users that match the query parameters.
bp-core/classes/class-bp-user-query.php: BP_User_Query::do_wp_user_query()

Use WP_User_Query() to pull data for the user IDs retrieved in the main query.
bp-core/classes/class-bp-user-query.php: bp_pre_user_query_construct

Fires before the construction of the BP_User_Query query.
Show 1 more use Hide more uses
Used By
Used By Description
bp-document/classes/class-bp-document.php: BP_Document::get_document_data()

Convert document IDs to document objects, as expected in template loop.
bp-document/classes/class-bp-document.php: BP_Document::get_folder_data()

Convert document IDs to document objects, as expected in template loop.
bp-document/classes/class-bp-document-folder.php: BP_Document_Folder::get_folder_data()

Convert document IDs to document objects, as expected in template loop.
bp-members/classes/class-bp-rest-members-endpoint.php: BP_REST_Members_Endpoint::get_items()

Retrieve users.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::get_items()

Retrieve group members.
bp-media/classes/class-bp-media-album.php: BP_Media_Album::get_album_data()

Convert media IDs to media objects, as expected in template loop.
bp-media/classes/class-bp-media.php: BP_Media::get_media_data()

Convert media IDs to media objects, as expected in template loop.
bp-groups/classes/class-bp-groups-member-suggestions.php: BP_Groups_Member_Suggestions::get_suggestions()

Find and return a list of username suggestions that match the query.
bp-members/bp-members-functions.php: bp_core_get_users()

Fetch an array of users based on the parameters passed.
bp-friends/bp-friends-activity.php: bp_friends_prefetch_activity_object_data()

Fetch data related to friended users at the beginning of an activity loop.
bp-friends/bp-friends-functions.php: bp_friends_prime_mentions_results()

Used by the Activity component’s @mentions to print a JSON list of the current user’s friends.
bp-core/classes/class-bp-members-suggestions.php: BP_Members_Suggestions::get_suggestions()

Find and return a list of username suggestions that match the query.
bp-activity/classes/class-bp-activity-activity.php: BP_Activity_Activity::get_activity_data()

Convert activity IDs to activity objects, as expected in template loop.
Show 8 more used by Hide more used by

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.