Contents

Code Reference Classes BP_REST_Mention_Endpoint

BP_REST_Mention_Endpoint

Settings endpoints.

Description

Source

File: bp-core/classes/class-bp-rest-mention-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
class BP_REST_Mention_Endpoint extends WP_REST_Controller {
 
    /**
     * Constructor.
     *
     * @since 0.1.0
     */
    public function __construct() {
        $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
        $this->rest_base = 'mention';
    }
 
    /**
     * Register the mention routes.
     *
     * @since 0.1.0
     */
    public function register_routes() {
        register_rest_route(
            $this->namespace,
            '/' . $this->rest_base,
            array(
                array(
                    'methods'             => WP_REST_Server::READABLE,
                    'callback'            => array( $this, 'get_items' ),
                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
                    'args'                => $this->get_collection_params(),
                ),
                'schema' => array( $this, 'get_item_schema' ),
            )
        );
    }
 
    /**
     * Retrieve members to mention.
     *
     * @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/mention Mention Member
     * @apiName        GetBBMention
     * @apiGroup       Components
     * @apiDescription Retrieve member which you want to mention in Activity OR Forum topic and reply.
     * @apiVersion     1.0.0
     * @apiPermission  LoggedInUser
     * @apiParam {String} term Members @name suggestions.
     * @apiParam {Boolean} [only_friends] Limit result set to Friends only.
     * @apiParam {Number} [group_id] A unique numeric ID for the Group. Limit result set to the group.
     */
    public function get_items( $request ) {
 
        $args = array(
            'term' => sanitize_text_field( $request['term'] ),
            'type' => 'members',
        );
 
        if ( ! empty( $request['only_friends'] ) ) {
            $args['only_friends'] = absint( $request['only_friends'] );
        } elseif (
            bp_is_active( 'messages' )
            && bp_is_active( 'friends' )
            && function_exists( 'bp_force_friendship_to_message' )
            && bp_force_friendship_to_message()
        ) {
            $args['only_friends'] = true;
        }
 
        if ( ! empty( $request['group_id'] ) ) {
            $args['group_id'] = absint( $request['group_id'] );
        }
 
        $results = bp_core_get_suggestions( $args );
 
        if ( is_wp_error( $results ) ) {
            return new WP_Error(
                'bp_rest_unknown_error',
                $results->get_error_message(),
                array(
                    'status' => 400,
                )
            );
        }
 
        $retval = array();
 
        foreach ( $results as $member ) {
            $retval[] = $this->prepare_response_for_collection(
                $this->prepare_item_for_response( $member, $request )
            );
        }
 
        $response = rest_ensure_response( $retval );
 
        /**
         * Fires after a component is updated via the REST API.
         *
         * @param array            $results  Component info.
         * @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_mention_items', $results, $response, $request );
 
        return $response;
    }
 
    /**
     * Check if a given request has access to list mentions.
     *
     * @param WP_REST_Request $request Full data about the request.
     *
     * @return bool|WP_Error
     * @since 0.1.0
     */
    public function get_items_permissions_check( $request ) {
        $retval = true;
 
        if ( ! is_user_logged_in() ) {
            $retval = new WP_Error(
                'bp_rest_authorization_required',
                __( 'Sorry, you do not have access to list mentions.', 'buddyboss' ),
                array(
                    'status' => rest_authorization_required_code(),
                )
            );
        }
 
        /**
         * Filter the mention `get_items` permissions check.
         *
         * @param bool|WP_Error   $retval  Returned value.
         * @param WP_REST_Request $request The request sent to the API.
         *
         * @since 0.1.0
         */
        return apply_filters( 'bp_rest_mention_get_items_permissions_check', $retval, $request );
    }
 
    /**
     * Prepares group data for return as an object.
     *
     * @param BP_Groups_Group $item    Group object.
     * @param WP_REST_Request $request Full details about the request.
     *
     * @return WP_REST_Response
     * @since 0.1.0
     */
    public function prepare_item_for_response( $item, $request ) {
 
        $data = array(
            'id'            => $item->user_id,
            'display_id'    => $item->ID,
            'user_nicename' => $item->user_nicename,
            'name'          => $item->name,
            'image'         => $item->image,
        );
 
        $data     = $this->add_additional_fields_to_object( $data, $request );
        $response = rest_ensure_response( $data );
 
        $response->add_links( $this->prepare_links( $item ) );
 
        /**
         * Filter a group value returned from the API.
         *
         * @param WP_REST_Response $response The response data.
         * @param WP_REST_Request  $request  Request used to generate the response.
         * @param BP_Groups_Group  $item     Group object.
         *
         * @since 0.1.0
         */
        return apply_filters( 'bp_rest_member_prepare_value', $response, $request, $item );
    }
 
    /**
     * Prepares links for the user request.
     *
     * @param object $user User object.
     *
     * @return array Links for the given user.
     */
    protected function prepare_links( $user ) {
        $links = array(
            'self' => array(
                'href' => rest_url( sprintf( '%s/%s/%d', $this->namespace, 'members', $user->user_id ) ),
            ),
        );
 
        return $links;
    }
 
    /**
     * Get the settings 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_mention',
            'type'       => 'object',
            'properties' => array(
                'id'            => array(
                    'context'     => array( 'embed', 'view', 'edit' ),
                    'description' => __( 'A unique numeric ID for the Member.', 'buddyboss' ),
                    'readonly'    => true,
                    'type'        => 'integer',
                ),
                'display_id'    => array(
                    'context'     => array( 'embed', 'view', 'edit' ),
                    'description' => __( 'Member\'s mention name.', 'buddyboss' ),
                    'readonly'    => true,
                    'type'        => 'string',
                ),
                'user_nicename' => array(
                    'context'     => array( 'embed', 'view', 'edit' ),
                    'description' => __( 'Member\'s nicename.', 'buddyboss' ),
                    'readonly'    => true,
                    'type'        => 'string',
                ),
                'name'          => array(
                    'context'     => array( 'embed', 'view', 'edit' ),
                    'description' => __( 'Member\'s display name.', 'buddyboss' ),
                    'readonly'    => true,
                    'type'        => 'string',
                ),
                'image'         => array(
                    'context'     => array( 'embed', 'view', 'edit' ),
                    'description' => __( 'Member\'s avatar image.', 'buddyboss' ),
                    'readonly'    => true,
                    'type'        => 'string',
                ),
            ),
        );
 
        /**
         * Filters the mention schema.
         *
         * @param string $schema The endpoint schema.
         */
        return apply_filters( 'bp_rest_mention_schema', $this->add_additional_fields_schema( $schema ) );
    }
 
    /**
     * Get the query params for collections.
     *
     * @return array
     * @since 0.1.0
     */
    public function get_collection_params() {
        $params = array(
            'term'         => array(
                'description'       => __( 'Members @name suggestions.', 'buddyboss' ),
                'required'          => true,
                'type'              => 'string',
                'sanitize_callback' => 'sanitize_text_field',
                'validate_callback' => 'rest_validate_request_arg',
            ),
            'only_friends' => array(
                'description'       => __( 'Limit result set to Friends only.', 'buddyboss' ),
                'type'              => 'boolean',
                'sanitize_callback' => 'rest_sanitize_boolean',
                'validate_callback' => 'rest_validate_request_arg',
            ),
            'group_id'     => array(
                'description'       => __( 'A unique numeric ID for the Group. Limit result set to the group.', 'buddyboss' ),
                'type'              => 'integer',
                'sanitize_callback' => 'sanitize_text_field',
                'validate_callback' => 'rest_validate_request_arg',
            ),
        );
 
        /**
         * Filters the collection query params.
         *
         * @param array $params Query params.
         */
        return apply_filters( 'bp_rest_mention_collection_params', $params );
    }
}

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.