Contents

Code Reference Classes BP_REST_Members_Details_Endpoint

BP_REST_Members_Details_Endpoint

BuddyPress Members Details endpoints.

Description

Source

File: bp-members/classes/class-bp-rest-members-details-endpoint.php

16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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
138
139
140
141
142
143
144
145
146
147
148
149
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
class BP_REST_Members_Details_Endpoint extends WP_REST_Users_Controller {
 
    /**
     * Current Users ID.
     *
     * @var integer Member ID.
     */
    protected $user_id;
 
    /**
     * Constructor.
     *
     * @since 0.1.0
     */
    public function __construct() {
        $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
        $this->rest_base = 'members';
    }
 
    /**
     * Register the component routes.
     *
     * @since 0.1.0
     */
    public function register_routes() {
        register_rest_route(
            $this->namespace,
            '/' . $this->rest_base . '/details',
            array(
                array(
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => array( $this, 'get_items' ),
                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
                ),
                'schema' => array( $this, 'get_item_schema' ),
            )
        );
 
        register_rest_route(
            $this->namespace,
            '/' . $this->rest_base . '/(?P<id>[\d]+)/detail',
            array(
                'args'   => array(
                    'id' => array(
                        'description' => __( 'A unique numeric ID for the member.', 'buddyboss' ),
                        'type'        => 'integer',
                        'required'    => 'true',
                    ),
                ),
                array(
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => array( $this, 'get_item' ),
                    'permission_callback' => array( $this, 'get_item_permissions_check' ),
                ),
                'schema' => array( $this, 'get_item_schema' ),
            )
        );
    }
 
    /**
     * Retrieve members details.
     *
     * @param WP_REST_Request $request Full details about the request.
     *
     * @return WP_REST_Response | WP_Error
     * @since 0.1.0
     *
     * @api {GET} /wp-json/buddyboss/v1/members/details Members Details
     * @apiName GetBBMembersDetails
     * @apiGroup Members
     * @apiDescription Retrieve Members details(includes tabs and order_options)
     * @apiVersion 1.0.0
     */
    public function get_items( $request ) {
        $retval = array();
 
        $retval['tabs']          = $this->get_members_tabs();
        $retval['order_options'] = function_exists( 'bp_nouveau_get_component_filters' ) ? bp_nouveau_get_component_filters( '', 'members' ) : $this->bp_rest_legacy_get_members_component_filters();
 
        $response = rest_ensure_response( $retval );
 
        /**
         * Fires after a list of members details is fetched via the REST API.
         *
         * @param WP_REST_Response $response The response data.
         * @param WP_REST_Request $request The request sent to the API.
         *
         * @since 0.1.0
         */
        do_action( 'bp_rest_members_details_get_items', $response, $request );
 
        return $response;
    }
 
    /**
     * Checks if a given request has access to get all users.
     *
     * @param WP_REST_Request $request Full details about the request.
     *
     * @return bool
     * @since 0.1.0
     */
    public function get_items_permissions_check( $request ) {
        $retval = true;
 
        if ( ! bp_is_active( 'members' ) ) {
            $retval = new WP_Error(
                'bp_rest_component_required',
                __( 'Sorry, Members component was not enabled.', 'buddyboss' ),
                array(
                    'status' => '404',
                )
            );
        }
 
        /**
         * Filter the members details permissions check.
         *
         * @param bool $retval Returned value.
         * @param WP_REST_Request $request The request sent to the API.
         *
         * @since 0.1.0
         */
        return apply_filters( 'bp_rest_members_get_items_permissions_check', $retval, $request );
    }
 
    /**
     * Retrieve member detail.
     *
     * @param WP_REST_Request $request Full details about the request.
     *
     * @return WP_REST_Response | WP_Error
     * @since 0.1.0
     *
     * @api            {GET} /wp-json/buddyboss/v1/members/:id/detail Members Detail
     * @apiName        GetBBMembersDetail
     * @apiGroup       Members
     * @apiDescription Retrieve Member detail tabs.
     * @apiVersion     1.0.0
     * @apiPermission  LoggedInUser if the site is in Private Network.
     * @apiParam {Number} id A unique numeric ID for the member.
     */
    public function get_item( $request ) {
        $retval = array();
        global $bp;
 
        $current_user_id = $request->get_param( 'id' );
        $this->user_id   = $current_user_id;
        if ( empty( $current_user_id ) ) {
            $current_user_id = bp_loggedin_user_id();
        }
 
        if ( empty( $current_user_id ) ) {
            return new WP_Error(
                'bp_rest_component_required',
                __( 'Sorry, Invalid member ID.', 'buddyboss' ),
                array(
                    'status' => '404',
                )
            );
        }
 
        $user = bp_rest_get_user( $current_user_id );
 
        if ( ! $user instanceof WP_User ) {
            return new WP_Error(
                'bp_rest_member_invalid_id',
                __( 'Invalid member ID.', 'buddyboss' ),
                array(
                    'status' => 404,
                )
            );
        }
 
        add_filter( 'bp_displayed_user_id', array( $this, 'bp_rest_get_displayed_user' ), 999 );
        bp_setup_nav();
        remove_filter( 'bp_displayed_user_id', array( $this, 'bp_rest_get_displayed_user' ), 999 );
 
        $profile_tabs = array();
        $default_tab  = 'profile';
        $navs         = buddypress()->members->nav;
 
        // if it's nouveau then let it order the tabs.
        if ( function_exists( 'bp_nouveau_set_nav_item_order' ) ) {
            bp_nouveau_set_nav_item_order( $navs, bp_nouveau_get_appearance_settings( 'user_nav_order' ) );
        }
 
        if ( function_exists( 'bp_nouveau_get_appearance_settings' ) ) {
            $tab         = bp_nouveau_get_appearance_settings( 'user_default_tab' );
            $default_tab = bp_is_active( $tab ) ? $tab : $default_tab;
        }
 
        $id_map = array(
            'activity' => 'activities',
            'profile'  => 'xprofile',
        );
 
        if ( ! empty( $navs->get_primary() ) ) {
            foreach ( $navs->get_primary() as $nav ) {
 
                $name = $nav['name'];
                $id   = $nav['slug'];
 
                // remove the notification numbers.
                $name = preg_replace( '/^(.*)(<(.*)<\/(.*)>)/', '$1', $name );
                $name = trim( $name );
 
                if ( isset( $id_map[ $id ] ) ) {
                    $id = $id_map[ $id ];
                }
 
                $tab = array(
                    'id'                      => $id,
                    'title'                   => $name,
                    'default'                 => false,
                    'count'                   => ( $this->bp_rest_nav_has_count( $nav ) ? $this->bp_rest_get_nav_count( $nav ) : '' ),
                    'show_for_displayed_user' => $nav['show_for_displayed_user'],
                    'children'                => array(),
                );
 
                if ( $default_tab === $nav['slug'] ) {
                    $tab['default'] = true;
                }
 
                $nav_sub = $navs->get_secondary(
                    array(
                        'parent_slug'     => $id,
                        'user_has_access' => true,
                    )
                );
 
                if ( ! empty( $nav_sub ) ) {
                    foreach ( $nav_sub as $s_nav ) {
                        $sub_name = preg_replace( '/^(.*)(<(.*)<\/(.*)>)/', '$1', $s_nav['name'] );
                        $sub_name = trim( $sub_name );
                        $sub_nav  = array(
                            'id'              => $s_nav['slug'],
                            'title'           => $sub_name,
                            'count'           => ( $this->bp_rest_nav_has_count( $s_nav ) ? $this->bp_rest_get_nav_count( $s_nav ) : '' ),
                            'position'        => $s_nav['position'],
                            'user_has_access' => $s_nav['user_has_access'],
                        );
 
                        $tab['children'][] = $sub_nav;
                    }
                }
 
                $profile_tabs[] = apply_filters( 'bp_rest_profile_tab', $tab, $nav );
            }
        }
 
        $retval['tabs'] = array_values( $profile_tabs );
 
        $response = rest_ensure_response( $retval );
 
        /**
         * Fires after a list of members details is fetched via the REST API.
         *
         * @param WP_REST_Response $response The response data.
         * @param WP_REST_Request  $request  The request sent to the API.
         *
         * @since 0.1.0
         */
        do_action( 'bp_rest_members_detail_get_items', $response, $request );
 
        return $response;
    }
 
    /**
     * Checks if a given request has access to get all users.
     *
     * @param WP_REST_Request $request Full details about the request.
     *
     * @return bool
     * @since 0.1.0
     */
    public function get_item_permissions_check( $request ) {
        $retval = true;
 
        if ( function_exists( 'bp_enable_private_network' ) && true !== bp_enable_private_network() && ! is_user_logged_in() ) {
            $retval = new WP_Error(
                'bp_rest_authorization_required',
                __( 'Sorry, Restrict access to only logged-in members.', 'buddyboss' ),
                array(
                    'status' => rest_authorization_required_code(),
                )
            );
        }
 
        if ( true === $retval && ! bp_is_active( 'members' ) ) {
            $retval = new WP_Error(
                'bp_rest_component_required',
                __( 'Sorry, Members component was not enabled.', 'buddyboss' ),
                array(
                    'status' => '404',
                )
            );
        }
 
        /**
         * Filter the members detail permissions check.
         *
         * @param bool $retval Returned value.
         * @param WP_REST_Request $request The request sent to the API.
         *
         * @since 0.1.0
         */
        return apply_filters( 'bp_rest_members_get_item_permissions_check', $retval, $request );
    }
 
    /**
     * Get the members details schema, conforming to JSON Schema.
     *
     * @return array
     * @since 0.1.0
     */
    public function get_item_schema() {
        $schema = array(
            '$schema'    => 'http://json-schema.org/draft-04/schema#',
            'title'      => 'bp_members_details',
            'type'       => 'object',
            'properties' => array(
                'tabs'          => array(
                    'context'     => array( 'embed', 'view' ),
                    'description' => __( 'Members directory tabs.', 'buddyboss' ),
                    'type'        => 'object',
                    'readonly'    => true,
                    'items'       => array(
                        'type' => 'array',
                    ),
                ),
                'order_options' => array(
                    'context'     => array( 'embed', 'view' ),
                    'description' => __( 'Members order by options.', 'buddyboss' ),
                    'type'        => 'array',
                    'readonly'    => true,
                ),
            ),
        );
 
        /**
         * Filters the members details schema.
         *
         * @param array $schema The endpoint schema.
         */
        return apply_filters( 'bp_rest_members_schema', $this->add_additional_fields_schema( $schema ) );
    }
 
    /**
     * Get Members tabs.
     *
     * @return array
     */
    public function get_members_tabs() {
        $tabs = array();
 
        $tabs_items = function_exists( 'bp_nouveau_get_members_directory_nav_items' ) ? bp_nouveau_get_members_directory_nav_items() : $this->bp_rest_legacy_get_members_directory_nav_items();
 
        if ( ! empty( $tabs_items ) ) {
            foreach ( $tabs_items as $key => $item ) {
                $tabs[ $key ]['title']    = $item['text'];
                $tabs[ $key ]['position'] = $item['position'];
                $tabs[ $key ]['count']    = $item['count'];
            }
        }
 
        return $tabs;
    }
 
    /**
     * Set current and display user with current user.
     *
     * @param int $user_id The user id.
     *
     * @return int
     */
    public function bp_rest_get_displayed_user( $user_id ) {
        return ( ! empty( $this->user_id ) ? $this->user_id : bp_loggedin_user_id() );
    }
 
    /**
     * Retrieve the count attribute for the current nav item.
     * - from bp_nouveau_get_nav_count();
     *
     * @param array $nav Navigation array.
     *
     * @return int The count attribute for the nav item.
     */
    protected function bp_rest_get_nav_count( $nav ) {
        $count = 0;
 
        if ( ! empty( $nav['primary'] ) ) {
            $span = strpos( $nav['name'], '<span' );
 
            // Grab count out of the <span> element.
            if ( false !== $span ) {
                $count_start = strpos( $nav['name'], '>', $span ) + 1;
                $count_end   = strpos( $nav['name'], '<', $count_start );
                $count       = (int) substr( $nav['name'], $count_start, $count_end - $count_start );
            }
        }
 
        /**
         * Filter to edit the count attribute for the nav item.
         *
         * @param int   $count    The count attribute for the nav item.
         * @param array $nav_item The current nav item array.
         */
        return (int) apply_filters( 'bp_rest_nouveau_get_nav_count', $count, $nav );
    }
 
    /**
     * Checks if the nav item has a count attribute.
     * - from bp_nouveau_nav_has_count();
     *
     * @param array $nav Navigation array.
     *
     * @return bool
     */
    public function bp_rest_nav_has_count( $nav ) {
        $count = false;
 
        if ( ! empty( $nav['primary'] ) ) {
            $count = (bool) strpos( $nav['name'], '="count"' );
        }
 
        /**
         * Filter to edit whether the nav has a count attribute.
         *
         * @param bool  $value    True if the nav has a count attribute. False otherwise
         * @param array $nav_item The current nav item array.
         */
        return (bool) apply_filters( 'bp_rest_nouveau_nav_has_count', false !== $count, $nav );
    }
 
    /**
     * Legacy template members directory navigation support added.
     *
     * @return mixed|void
     */
    public function bp_rest_legacy_get_members_directory_nav_items() {
        $nav_items = array();
 
        $nav_items['all'] = array(
            'text'     => __( 'All Members', 'buddyboss' ),
            'position' => 5,
            'count'    => bp_get_total_member_count(),
        );
 
        if ( is_user_logged_in() ) {
            if ( bp_is_active( 'friends' ) && bp_get_total_friend_count( bp_loggedin_user_id() ) ) {
                $nav_items['friends'] = array(
                    'text'     => __( 'My Friends', 'buddyboss' ),
                    'position' => 15,
                    'count'    => bp_get_total_friend_count( bp_loggedin_user_id() ),
                );
            }
        }
 
        return apply_filters( 'bp_rest_legacy_get_members_directory_nav_items', $nav_items );
    }
 
    /**
     * Legacy template members directory filter support added.
     *
     * @return mixed
     */
    public function bp_rest_legacy_get_members_component_filters() {
 
        $filters_data = array();
 
        $filters_data['active'] = __( 'Last Active', 'buddyboss' );
        $filters_data['newest'] = __( 'Newest Registered', 'buddyboss' );
        if ( is_user_logged_in() ) {
            if ( bp_is_active( 'xprofile' ) ) {
                $filters_data['alphabetical'] = __( 'Alphabetical', 'buddyboss' );
            }
        }
 
        return apply_filters( 'bp_rest_legacy_get_members_component_filters', $filters_data );
    }
 
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Methods

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.