BP_REST_Members_Actions_Endpoint
BuddyPress Members Actions endpoints.
Description
Source
File: bp-members/classes/class-bp-rest-members-actions-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 | class BP_REST_Members_Actions_Endpoint extends WP_REST_Users_Controller { /** * Reuse some parts of the BP_REST_Members_Endpoint class. * * @since 0.1.0 * * @var BP_REST_Members_Endpoint */ protected $members_endpoint; /** * Constructor. * * @since 0.1.0 */ public function __construct() { $this->namespace = bp_rest_namespace() . '/' . bp_rest_version(); $this->rest_base = buddypress()->members->id . '/action'; $this->members_endpoint = new BP_REST_Members_Endpoint(); } /** * Register the component routes. * * @since 0.1.0 */ public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array( 'args' => array( 'id' => array( 'description' => __( 'A unique numeric ID for the member.', 'buddyboss' ), 'type' => 'integer', ), 'action' => array( 'description' => __( 'Action name which you want to perform for the member.', 'buddyboss' ), 'type' => 'string', 'enum' => apply_filters( 'bp_rest_members_action_enum_args', array( 'follow', 'unfollow' ) ), 'validate_callback' => 'rest_validate_request_arg', ), ), array( 'methods' => WP_REST_Server::EDITABLE, 'callback' => array( $this, 'update_item' ), 'permission_callback' => array( $this, 'update_item_permissions_check' ), ), 'schema' => array( $this, 'get_item_schema' ), ) ); } /** * Checks if a given request has access create members. * * @param WP_REST_Request $request Full details about the request. * * @return bool|WP_Error * @since 0.1.0 * * @api {POST} /wp-json/buddyboss/v1/members/action/:user_id Member Action * @apiName GetBBMembers-UpdateMembersAction * @apiGroup Members * @apiDescription Update members action * @apiVersion 1.0.0 * @apiPermission LoggedInUser * @apiParam {Number} user_id A unique numeric ID for the member. * @apiParam {String=follow,unfollow} action Action name which you want to perform for the member. */ public function update_item( $request ) { // Setting context. $request->set_param( 'context', 'edit' ); $args = array( 'leader_id' => (int) $request['id'], 'follower_id' => get_current_user_id(), ); $response = array(); $retval = array(); $response['action'] = false; /** * Filter the query arguments for the request. * * @param array $args Key value array of query var to query value. * @param WP_REST_Request $request The request sent to the API. * * @since 0.1.0 */ $args = apply_filters( 'bp_rest_members_action_query_args', $args, $request ); $action = $request['action']; switch ( $action ) { case 'follow': if ( ! $this->bp_rest_follow_is_following( $args ) ) { $result = $this->bp_rest_follow_start_following( $args ); $response['action'] = ( ! empty( $result ) ? true : false ); } break; case 'unfollow': if ( $this->bp_rest_follow_is_following( $args ) ) { $result = $this->bp_rest_follow_stop_following( $args ); $response['action'] = ( ! empty( $result ) ? true : false ); } break; } $member_query = bp_core_get_users( array( 'include' => (int) $request['id'] ) ); $members = $member_query['users']; $request->set_param( 'context', 'view' ); foreach ( $members as $member ) { $retval[] = $this->prepare_response_for_collection( $this->members_endpoint->prepare_item_for_response( $member, $request ) ); } $response['data'] = ( count( $members ) > 1 ? $retval : ( ! empty( $retval ) ? $retval[0] : '' ) ); $response = rest_ensure_response( $response ); /** * Fires after a Member action is updated via the REST API. * * @param BP_XProfile_Field $field Created field object. * @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_action_update_item', $response, $request ); return $response; } /** * Check if a given request has access to update a member. * * @param WP_REST_Request $request Full details about the request. * * @return bool|WP_Error * @since 0.1.0 */ public function update_item_permissions_check( $request ) { $retval = true; $user = bp_rest_get_user( $request['id'] ); if ( ! $user instanceof WP_User ) { $retval = new WP_Error( 'bp_rest_member_invalid_id', __( 'Invalid member ID.', 'buddyboss' ), array( 'status' => 404, ) ); } if ( ! is_user_logged_in() ) { $retval = new WP_Error( 'bp_rest_authorization_required', __( 'Sorry, you do not have access to list components.', 'buddyboss' ), array( 'status' => rest_authorization_required_code(), ) ); } /** * Filter the members `update_item` 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_members_action_update_item_permissions_check', $retval, $request ); } /** * Get the members action schema, conforming to JSON Schema. * * @return array * @since 0.1.0 */ public function get_item_schema() { $schema = array( 'title' => 'bp_members_action', 'type' => 'object', 'properties' => array( 'action' => array( 'description' => __( 'Action performed or not.', 'buddyboss' ), 'type' => 'boolean', 'context' => array( 'edit' ), 'readonly' => true, ), 'data' => array( 'description' => __( 'Object of member.', 'buddyboss' ), 'type' => 'object', 'context' => array( 'edit' ), 'readonly' => true, 'properties' => array( 'id' => array( 'description' => __( 'A unique numeric ID for the Member.', 'buddyboss' ), 'type' => 'integer', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, ), 'name' => array( 'description' => __( 'Display name for the member.', 'buddyboss' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), 'arg_options' => array( 'sanitize_callback' => 'sanitize_text_field', ), ), 'mention_name' => array( 'description' => __( 'The name used for that user in @-mentions.', 'buddyboss' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), 'arg_options' => array( 'sanitize_callback' => 'sanitize_text_field', ), ), 'link' => array( 'description' => __( 'Profile URL of the member.', 'buddyboss' ), 'type' => 'string', 'format' => 'uri', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, ), 'user_login' => array( 'description' => __( 'An alphanumeric identifier for the Member.', 'buddyboss' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), 'required' => true, 'arg_options' => array( 'sanitize_callback' => array( $this, 'check_username' ), ), ), 'member_types' => array( 'description' => __( 'Member types associated with the member.', 'buddyboss' ), 'type' => 'object', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, ), 'xprofile' => array( 'description' => __( 'Member XProfile groups and its fields.', 'buddyboss' ), 'type' => 'array', 'context' => array( 'view', 'edit' ), 'readonly' => true, ), 'friendship_status' => array( 'description' => __( 'Friendship relation with, current, logged in user.', 'buddyboss' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, 'enum' => array( 'is_friends', 'not_friends', 'pending', 'awaiting_response' ), ), 'is_following' => array( 'description' => __( 'Check if a user is following or not.', 'buddyboss' ), 'type' => 'boolean', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, ), ), ), ), ); // Avatars. if ( true === buddypress()->avatar->show_avatars ) { $avatar_properties = array(); $avatar_properties['full'] = array( /* translators: Full image size for the member Avatar */ 'description' => sprintf( __( 'Avatar URL with full image size (%1$d x %2$d pixels).', 'buddyboss' ), number_format_i18n( bp_core_avatar_full_width() ), number_format_i18n( bp_core_avatar_full_height() ) ), 'type' => 'string', 'format' => 'uri', 'context' => array( 'embed', 'view', 'edit' ), ); $avatar_properties['thumb'] = array( /* translators: Thumb imaze size for the member Avatar */ 'description' => sprintf( __( 'Avatar URL with thumb image size (%1$d x %2$d pixels).', 'buddyboss' ), number_format_i18n( bp_core_avatar_thumb_width() ), number_format_i18n( bp_core_avatar_thumb_height() ) ), 'type' => 'string', 'format' => 'uri', 'context' => array( 'embed', 'view', 'edit' ), ); $schema['properties']['data']['avatar_urls'] = array( 'description' => __( 'Avatar URLs for the member.', 'buddyboss' ), 'type' => 'object', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, 'properties' => $avatar_properties, ); } $schema['properties']['data']['cover_url'] = array( 'description' => __( 'Cover images URL for the member.', 'buddyboss' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, ); /** * Filters the members action schema. * * @param array $schema The endpoint schema. */ return apply_filters( 'bp_rest_members_action_schema', $this->add_additional_fields_schema( $schema ) ); } /** * Check member is following or not. * * @param array $args Argument with leader_id and follower_id. * * @return mixed */ private function bp_rest_follow_is_following( $args ) { if ( bp_is_active( 'follow' ) && function_exists( 'bp_follow_is_following' ) ) { return bp_follow_is_following( $args ); } elseif ( function_exists( 'bp_is_following' ) ) { return bp_is_following( $args ); } return false; } /** * Start Following the member. * * @param array $args Argument with leader_id and follower_id. * * @return mixed */ private function bp_rest_follow_start_following( $args ) { if ( bp_is_active( 'follow' ) && function_exists( 'bp_follow_start_following' ) ) { return bp_follow_start_following( $args ); } elseif ( function_exists( 'bp_start_following' ) ) { return bp_start_following( $args ); } return false; } /** * Stop Following the member. * * @param array $args Argument with leader_id and follower_id. * * @return mixed */ private function bp_rest_follow_stop_following( $args ) { if ( bp_is_active( 'follow' ) && function_exists( 'bp_follow_stop_following' ) ) { return bp_follow_stop_following( $args ); } elseif ( function_exists( 'bp_stop_following' ) ) { return bp_stop_following( $args ); } return false; }} |
Changelog
| Version | Description |
|---|---|
| 0.1.0 | Introduced. |
Methods
- __construct — Constructor.
- bp_rest_follow_is_following — Check member is following or not.
- bp_rest_follow_start_following — Start Following the member.
- bp_rest_follow_stop_following — Stop Following the member.
- get_item_schema — Get the members action schema, conforming to JSON Schema.
- register_routes — Register the component routes.
- update_item — Checks if a given request has access create members.
- update_item_permissions_check — Check if a given request has access to update a member.
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.