BP_REST_XProfile_Data_Endpoint
XProfile Data endpoints.
Description
Use /xprofile/{field_id}/data/{user_id}
Source
File: bp-xprofile/classes/class-bp-rest-xprofile-data-endpoint.php
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 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 | class BP_REST_XProfile_Data_Endpoint extends WP_REST_Controller { /** * XProfile Fields Class. * * @since 0.1.0 * * @var BP_REST_XProfile_Fields_Endpoint */ protected $fields_endpoint; /** * Constructor. * * @since 0.1.0 */ public function __construct() { $this->namespace = bp_rest_namespace() . '/' . bp_rest_version(); $this->rest_base = buddypress()->profile->id; $this->fields_endpoint = new BP_REST_XProfile_Fields_Endpoint(); } /** * Register the component routes. * * @since 0.1.0 */ public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<field_id>[\d]+)/data/(?P<user_id>[\d]+)', array( 'args' => array( 'field_id' => array( 'description' => __( 'The ID of the field the data is from.', 'buddyboss' ), 'type' => 'integer', ), 'user_id' => array( 'description' => __( 'The ID of user the field data is from.', 'buddyboss' ), 'type' => 'integer', ), ), array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_item' ), 'permission_callback' => array( $this, 'get_item_permissions_check' ), ), array( 'methods' => WP_REST_Server::EDITABLE, 'callback' => array( $this, 'update_item' ), 'permission_callback' => array( $this, 'update_item_permissions_check' ), 'args' => array( 'value' => array( 'description' => __( 'The list of values for the field data.', 'buddyboss' ), // @todo Removed to support array and object both. /*'type' => 'object', 'items' => array( 'type' => 'string', ), 'arg_options' => array( 'validate_callback' => 'rest_validate_request_arg', 'sanitize_callback' => 'rest_sanitize_request_arg', ),*/ ), ), ), array( 'methods' => WP_REST_Server::DELETABLE, 'callback' => array( $this, 'delete_item' ), 'permission_callback' => array( $this, 'delete_item_permissions_check' ), ), 'schema' => array( $this, 'get_item_schema' ), ) ); } /** * Retrieve single XProfile field data. * * @param WP_REST_Request $request Full data about the request. * * @return WP_REST_Response | WP_Error * @since 0.1.0 * * @api {GET} /wp-json/buddyboss/v1/xprofile/:field_id/data/:user_id Get xProfile Field Data * @apiName GetBBxProfileFieldData * @apiGroup Profile Fields * @apiDescription Retrieve xProfile Field data for the user. * @apiVersion 1.0.0 * @apiPermission LoggedInUser if the site is in Private Network. * @apiParam {Number} field_id The ID of the field the data is from. * @apiParam {Number} user_id The ID of user the field data is from. */ public function get_item( $request ) { // Get Field data. $field_data = $this->get_xprofile_field_data_object( $request->get_param( 'field_id' ), $request->get_param( 'user_id' ) ); $retval = $this->prepare_response_for_collection( $this->prepare_item_for_response( $field_data, $request ) ); $response = rest_ensure_response( $retval ); /** * Fires before a XProfile data is retrieved via the REST API. * * @param BP_XProfile_ProfileData $field_data The field data 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_xprofile_data_get_item', $field_data, $response, $request ); return $response; } /** * Check if a given request has access to get users's data. * * @param WP_REST_Request $request Full data about the request. * * @return WP_Error|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(), ) ); } // Check the field exists. $field = $this->get_xprofile_field_object( $request->get_param( 'field_id' ) ); if ( true === $retval && empty( $field->id ) ) { $retval = new WP_Error( 'bp_rest_invalid_id', __( 'Invalid field ID.', 'buddyboss' ), array( 'status' => 404, ) ); } if ( true === $retval && ! bp_current_user_can( 'bp_moderate' ) ) { $retval = $this->fields_endpoint->get_xprofile_field_display_permission( $retval, $field->id ); } // Check the requested user exists. if ( true === $retval && ! bp_rest_get_user( $request->get_param( 'user_id' ) ) ) { $retval = new WP_Error( 'bp_rest_member_invalid_id', __( 'Invalid member ID.', 'buddyboss' ), array( 'status' => 404, ) ); } // Check the user can view this field value. $hidden_user_fields = bp_xprofile_get_hidden_fields_for_user( $request->get_param( 'user_id' ) ); if ( true === $retval && in_array( $field->id, $hidden_user_fields, true ) ) { $retval = new WP_Error( 'bp_rest_hidden_profile_field', __( 'Sorry, the profile field value is not viewable for this user.', 'buddyboss' ), array( 'status' => 403, ) ); } /** * Filter the XProfile data `get_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_xprofile_data_get_item_permissions_check', $retval, $request ); } /** * Save XProfile data. * * @param WP_REST_Request $request Full data about the request. * * @return WP_REST_Response | WP_Error * @since 0.1.0 * * @api {PATCH} /wp-json/buddyboss/v1/xprofile/:field_id/data/:user_id Update xProfile Field Data * @apiName UpdateBBxProfileData * @apiGroup Profile Fields * @apiDescription Update xProfile field data for the user. * @apiVersion 1.0.0 * @apiPermission LoggedInUser * @apiParam {Number} field_id The ID of the field the data is from. * @apiParam {Number} user_id The ID of user the field data is from. * @apiParam {Array} [value] The list of values for the field data. */ public function update_item( $request ) { // Setting context. $request->set_param( 'context', 'edit' ); $field = $this->get_xprofile_field_object( $request->get_param( 'field_id' ) ); if ( empty( $field->id ) ) { return new WP_Error( 'bp_rest_invalid_id', __( 'Invalid field ID.', 'buddyboss' ), array( 'status' => 404, ) ); } $user = bp_rest_get_user( $request->get_param( 'user_id' ) ); $value = $request->get_param( 'value' ); /** * For field types not supporting multiple values, join values in case * the submitted value was not an array. */ if ( ! $field->type_obj->supports_multiple_defaults && is_array( $value ) && ! in_array( $field->type, apply_filters( 'bp_rest_xprofile_mutiple', array( 'socialnetworks' ) ) ) ) { $value = implode( ' ', $value ); } if ( ! xprofile_set_field_data( $field->id, $user->ID, $value ) ) { return new WP_Error( 'rest_user_cannot_save_xprofile_data', __( 'Cannot save XProfile data.', 'buddyboss' ), array( 'status' => 500, ) ); } // Get Field data. $field_data = $this->get_xprofile_field_data_object( $field->id, $user->ID ); // Create Additional fields. $fields_update = $this->update_additional_fields_for_object( $field_data, $request ); if ( is_wp_error( $fields_update ) ) { return $fields_update; } $retval = $this->prepare_response_for_collection( $this->prepare_item_for_response( $field_data, $request ) ); $response = rest_ensure_response( $retval ); /** * Fires after a XProfile data is saved via the REST API. * * @param BP_XProfile_Field $field The field object. * @param BP_XProfile_ProfileData $field_data The field data object. * @param WP_User $user The user 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_xprofile_data_save_item', $field, $field_data, $user, $response, $request ); return $response; } /** * Check if a given request has access to save XProfile field data. * * @param WP_REST_Request $request Full data about the request. * * @return WP_Error|bool * @since 0.1.0 */ public function update_item_permissions_check( $request ) { $retval = true; if ( ! is_user_logged_in() ) { $retval = new WP_Error( 'bp_rest_authorization_required', __( 'Sorry, you need to be logged in to save XProfile data.', 'buddyboss' ), array( 'status' => rest_authorization_required_code(), ) ); } $user = bp_rest_get_user( $request->get_param( 'user_id' ) ); if ( true === $retval && ! $user instanceof WP_User ) { $retval = new WP_Error( 'bp_rest_invalid_id', __( 'Invalid member ID.', 'buddyboss' ), array( 'status' => 404, ) ); } $field = $this->get_xprofile_field_object( $request->get_param( 'field_id' ) ); if ( true === $retval && empty( $field->id ) ) { return new WP_Error( 'bp_rest_invalid_id', __( 'Invalid field ID.', 'buddyboss' ), array( 'status' => 404, ) ); } if ( true === $retval && ! bp_current_user_can( 'bp_moderate' ) ) { $retval = $this->fields_endpoint->get_xprofile_field_display_permission( $retval, $field->id ); } if ( true === $retval && ! $this->can_see( $user->ID ) ) { $retval = new WP_Error( 'bp_rest_authorization_required', __( 'Sorry, you cannot save XProfile field data.', 'buddyboss' ), array( 'status' => rest_authorization_required_code(), ) ); } /** * Filter the XProfile data `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_xprofile_data_update_item_permissions_check', $retval, $request ); } /** * Delete user's xProfile data. * * @param WP_REST_Request $request Full data about the request. * * @return WP_REST_Response | WP_Error * @since 0.1.0 * * @api {DELETE} /wp-json/buddyboss/v1/xprofile/:field_id/data/:user_id Delete xProfile Field Data * @apiName DeleteBBxProfileData * @apiGroup Profile Fields * @apiDescription Delete user's xProfile data. * @apiVersion 1.0.0 * @apiPermission LoggedInUser * @apiParam {Number} field_id The ID of the field the data is from. * @apiParam {Number} user_id The ID of user the field data is from. */ public function delete_item( $request ) { // Setting context. $request->set_param( 'context', 'edit' ); $field = $this->get_xprofile_field_object( $request->get_param( 'field_id' ) ); if ( empty( $field->id ) ) { return new WP_Error( 'bp_rest_invalid_id', __( 'Invalid field ID.', 'buddyboss' ), array( 'status' => 404, ) ); } $user = bp_rest_get_user( $request->get_param( 'user_id' ) ); // Get the field data before it's deleted. $field_data = $this->get_xprofile_field_data_object( $field->id, $user->ID ); // Set empty for the response. $field_data->value = ''; $previous = $this->prepare_item_for_response( $field_data, $request ); if ( false === $field_data->delete() ) { return new WP_Error( 'bp_rest_xprofile_data_cannot_delete', __( 'Could not delete XProfile data.', 'buddyboss' ), array( 'status' => 500, ) ); } // Build the response. $response = new WP_REST_Response(); $response->set_data( array( 'deleted' => true, 'previous' => $previous->get_data(), ) ); /** * Fires after a XProfile data is deleted via the REST API. * * @param BP_XProfile_Field $field Deleted field object. * @param BP_XProfile_ProfileData $field_data Deleted field data object. * @param WP_User $user User 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_xprofile_data_delete_item', $field, $field_data, $user, $response, $request ); return $response; } /** * Check if a given request has access to delete users's data. * * @param WP_REST_Request $request Full data about the request. * * @return WP_Error|bool * @since 0.1.0 */ public function delete_item_permissions_check( $request ) { $retval = $this->update_item_permissions_check( $request ); /** * Filter the XProfile data `delete_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_xprofile_data_delete_item_permissions_check', $retval, $request ); } /** * Prepares XProfile data to return as an object. * * @param BP_XProfile_ProfileData $field_data XProfile field data object. * @param WP_REST_Request $request Full data about the request. * * @return WP_REST_Response * @since 0.1.0 */ public function prepare_item_for_response( $field_data, $request ) { $data = array( 'id' => $field_data->id, 'field_id' => $field_data->field_id, 'user_id' => $field_data->user_id, 'value' => array( 'raw' => $field_data->value, 'unserialized' => $this->fields_endpoint->get_profile_field_unserialized_value( $field_data->value ), 'rendered' => $this->fields_endpoint->get_profile_field_rendered_value( $field_data->value, $field_data->field_id ), ), 'last_updated' => bp_rest_prepare_date_response( $field_data->last_updated ), ); $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; $data = $this->add_additional_fields_to_object( $data, $request ); $data = $this->filter_response_by_context( $data, $context ); $response = rest_ensure_response( $data ); $response->add_links( $this->prepare_links( $field_data ) ); /** * Filter the XProfile data response 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_XProfile_ProfileData $field_data XProfile field data object. * * @since 0.1.0 */ return apply_filters( 'bp_rest_xprofile_data_prepare_value', $response, $request, $field_data ); } /** * Prepare links for the request. * * @param BP_XProfile_ProfileData $field_data XProfile field data object. * * @return array * @since 0.1.0 */ protected function prepare_links( $field_data ) { $base = sprintf( '/%s/%s/', $this->namespace, $this->rest_base ); // Entity meta. $links = array( 'self' => array( 'href' => rest_url( $base . $field_data->field_id ), ), 'user' => array( 'href' => rest_url( bp_rest_get_user_url( $field_data->user_id ) ), 'embeddable' => true, ), ); /** * Filter links prepared for the REST response. * * @param array $links The prepared links of the REST response. * @param BP_XProfile_ProfileData $field_data XProfile field data object. * * @since 0.1.0 */ return apply_filters( 'bp_rest_xprofile_data_prepare_links', $links, $field_data ); } /** * Get XProfile field object. * * @param int $field_id Field id. * * @return BP_XProfile_Field * @since 0.1.0 */ public function get_xprofile_field_object( $field_id ) { return $this->fields_endpoint->get_xprofile_field_object( $field_id ); } /** * Get XProfile field data object. * * @param int $field_id Field id. * @param int $user_id User id. * * @return BP_XProfile_ProfileData * @since 0.1.0 */ public function get_xprofile_field_data_object( $field_id, $user_id ) { return new BP_XProfile_ProfileData( $field_id, $user_id ); } /** * Can this user see the XProfile data? * * @param int $field_user_id User ID of the field. * * @return bool * @since 0.1.0 */ protected function can_see( $field_user_id ) { return ( bp_current_user_can( 'bp_moderate' ) || bp_loggedin_user_id() === $field_user_id ); } /** * Get the XProfile data schema, conforming to JSON Schema. * * @return array * @since 0.1.0 */ public function get_item_schema() { $schema = array( 'title' => 'bp_xprofile_data', 'type' => 'object', 'properties' => array( 'id' => array( 'context' => array( 'embed', 'view', 'edit' ), 'description' => __( 'A unique numeric ID for the profile data.', 'buddyboss' ), 'readonly' => true, 'type' => 'integer', ), 'field_id' => array( 'context' => array( 'embed', 'view', 'edit' ), 'description' => __( 'The ID of the field the data is from.', 'buddyboss' ), 'readonly' => true, 'type' => 'integer', ), 'user_id' => array( 'context' => array( 'embed', 'view', 'edit' ), 'description' => __( 'The ID of the user the field data is from.', 'buddyboss' ), 'readonly' => true, 'type' => 'integer', ), 'value' => array( 'context' => array( 'embed', 'view', 'edit' ), 'description' => __( 'The value of the field data.', 'buddyboss' ), 'type' => 'object', 'arg_options' => array( 'sanitize_callback' => null, 'validate_callback' => null, ), 'properties' => array( 'raw' => array( 'description' => __( 'Value for the field, as it exists in the database.', 'buddyboss' ), 'type' => 'string', 'context' => array( 'edit' ), ), 'unserialized' => array( 'description' => __( 'Unserialized value for the field, regular string will be casted as array.', 'buddyboss' ), 'type' => 'array', 'context' => array( 'embed', 'view', 'edit' ), 'items' => array( 'type' => 'string', ), 'readonly' => true, ), 'rendered' => array( 'description' => __( 'HTML value for the field, transformed for display.', 'buddyboss' ), 'type' => 'string', 'context' => array( 'embed', 'view', 'edit' ), 'readonly' => true, ), ), ), 'last_updated' => array( 'context' => array( 'embed', 'view', 'edit' ), 'description' => __( 'The date the field data was last updated, in the site\'s timezone.', 'buddyboss' ), 'type' => 'string', 'format' => 'date-time', ), ), ); /** * Filters the xprofile data schema. * * @param array $schema The endpoint schema. */ return apply_filters( 'bp_rest_xprofile_data_schema', $this->add_additional_fields_schema( $schema ) ); }} |
Changelog
| Version | Description |
|---|---|
| 0.1.0 | Introduced. |
Methods
- __construct — Constructor.
- can_see — Can this user see the XProfile data?
- delete_item — Delete user's xProfile data.
- delete_item_permissions_check — Check if a given request has access to delete users's data.
- get_item — Retrieve single XProfile field data.
- get_item_permissions_check — Check if a given request has access to get users's data.
- get_item_schema — Get the XProfile data schema, conforming to JSON Schema.
- get_xprofile_field_data_object — Get XProfile field data object.
- get_xprofile_field_object — Get XProfile field object.
- prepare_item_for_response — Prepares XProfile data to return as an object.
- prepare_links — Prepare links for the request.
- register_routes — Register the component routes.
- update_item — Save XProfile data.
- update_item_permissions_check — Check if a given request has access to save XProfile field data.
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.