Changeset 14026 for trunk/src/bp-core/bp-core-rest-api.php

Timestamp:

09/27/2024 09:11:27 PM (15 months ago)

Author:

espellcaste

Message:

Include the V2 of the BP REST API in BuddyPress core.

We are officially deprecating the V1 of the BP REST API. And bundling the new, default, V2 of the BP REST API inside BuddyPress core. Previously, the V1 was developed as a plugin in a separate repo (​https://github.com/buddypress/BP-REST).

• One of the main differences between the V1 and V2 is how objects are returned. Single items are no longer returned as an array;
• We have a new BP_Test_REST_Controller_Testcase for testing the new API endpoints;
• We changed the names of our controllers to follow our autoloader rules;
• Removed the BP-REST plugin from wp-env and from our release script;
• And we added notices for the deprecated V1 API (endpoints and files).

Props imath & I. ;)

Fixes #8200
See #9145
Closes ​https://github.com/buddypress/buddypress/pull/337

File:

• trunk/src/bp-core/bp-core-rest-api.php (modified) (13 diffs)

trunk/src/bp-core/bp-core-rest-api.php

@@ -12 +12 @@
 
 /**
- * Is the BP REST plugin is active?
+ * Is the BP REST plugin active?
  *
  * @since 5.0.0
@@ -23 +23 @@
 
 /**
- * Should we use the REST Endpoints of built BuddyPress?
+ * Should we use BuddyPress core REST Endpoints?
  *
  * If the BP REST plugin is active, it overrides BuddyPress REST endpoints.
- * This allows us to carry on maintaining all the BP REST API endpoints from
- * the BP REST plugin on GitHub.
- *
- * @since 5.0.0
- *
- * @return bool Whether to use the REST Endpoints of built BuddyPress.
+ *
+ * @since 5.0.0
+ *
+ * @return bool Whether to use BuddyPress core REST endpoints.
  */
 function bp_rest_in_buddypress() {
-    return ! bp_is_running_from_src_subdirectory() && ! bp_rest_is_plugin_active();
+    return ! bp_rest_is_plugin_active();
 }
 
@@ -55 +53 @@
      * @param bool $api_is_available True if the BP REST API is available. False otherwise.
      */
-    return apply_filters( 'bp_rest_api_is_available', bp_rest_in_buddypress() ) || bp_rest_is_plugin_active();
-}
-
-/**
- * Register the jQuery.ajax wrapper for BP REST API requests.
- *
- * @since 5.0.0
- * @deprecated 10.0.0
- */
-function bp_rest_api_register_request_script() {
-    if ( ! bp_rest_api_is_available() ) {
-        return;
-    }
-
-    wp_register_script(
-        'bp-api-request',
-        sprintf( '%1$sbp-core/js/bp-api-request%2$s.js', buddypress()->plugin_url, bp_core_get_minified_asset_suffix() ),
-        array( 'jquery', 'wp-api-request' ),
-        bp_get_version(),
-        true
-    );
-
-    wp_localize_script(
-        'bp-api-request',
-        'bpApiSettings',
-        array(
-            'unexpectedError'   => __( 'An unexpected error occured. Please try again.', 'buddypress' ),
-            'deprecatedWarning' => __( 'The bp.apiRequest function is deprecated since BuddyPress 10.0.0, please use wp.apiRequest instead.', 'buddypress' ),
-        )
-    );
-}
-add_action( 'bp_init', 'bp_rest_api_register_request_script' );
+    return apply_filters( 'bp_rest_api_is_available', ( bp_rest_in_buddypress() || bp_rest_is_plugin_active() ) );
+}
 
 /**
@@ -111 +79 @@
  *
  * @since 5.0.0
+ * @since 15.0.0 Version is now v2.
  *
  * @return string
@@ -120 +89 @@
      *
      * @since 5.0.0
-     *
-     * @param string $version BuddyPress core version.
+     * @since 15.0.0 Default version is now v2.
+     *
+     * @param string $bp_version BuddyPress REST API version.
      */
-    return apply_filters( 'bp_rest_version', 'v1' );
+    return apply_filters( 'bp_rest_version', 'v2' );
 }
 
@@ -198 +168 @@
  *
  * @param string $value Comma-separated list of group types.
- * @return array|null
+ * @return array|null|string
  */
 function bp_rest_sanitize_member_types( $value ) {
@@ -210 +180 @@
     $valid_types        = array_intersect( $types, $registered_types );
 
-    return ( ! empty( $valid_types ) ) ? $valid_types : null;
+    return ! empty( $valid_types ) ? $valid_types : null;
 }
 
@@ -219 +189 @@
  *
  * @param  mixed $value Mixed value.
- * @return WP_Error|bool
+ * @return WP_Error|true
  */
 function bp_rest_validate_member_types( $value ) {
@@ -244 +214 @@
         }
     }
+
+    return true;
 }
 
@@ -251 +223 @@
  * @since 5.0.0
  *
- * @param string $value Comma-separated list of group types.
+ * @param string $group_types Comma-separated list of group types.
  * @return array|null
  */
-function bp_rest_sanitize_group_types( $value ) {
-    if ( empty( $value ) ) {
+function bp_rest_sanitize_group_types( $group_types ) {
+    if ( empty( $group_types ) ) {
         return null;
     }
 
-    $types       = explode( ',', $value );
+    $types       = explode( ',', $group_types );
     $valid_types = array_intersect( $types, bp_groups_get_group_types() );
 
@@ -270 +242 @@
  * @since 5.0.0
  *
- * @param  mixed $value Mixed value.
+ * @param  mixed $group_types Mixed value.
  * @return WP_Error|bool
  */
-function bp_rest_validate_group_types( $value ) {
-    if ( empty( $value ) ) {
+function bp_rest_validate_group_types( $group_types ) {
+    if ( empty( $group_types ) ) {
         return true;
     }
 
-    $types            = explode( ',', $value );
+    $types            = explode( ',', $group_types );
     $registered_types = bp_groups_get_group_types();
     foreach ( $types as $type ) {
@@ -293 +265 @@
         }
     }
+
+    return true;
 }
 
@@ -388 +362 @@
     return isset( $registered_fields[ $attribute ] );
 }
+
+/**
+ * Filter the WP REST API response to return a 404 if the request is for the V1 of the BP REST API.
+ *
+ * @param mixed           $result Response to replace the requested version with. Can be anything
+ *                                a normal endpoint can return, or null to not hijack the request.
+ * @param WP_REST_Server  $server Server instance.
+ * @param WP_REST_Request $request Request used to generate the response.
+ *
+ * @return mixed
+ */
+function bp_rest_api_v1_dispatch_error( $result, $server, $request ) {
+
+    // Bail early if the BP REST plugin is active.
+    if ( bp_rest_is_plugin_active() ) {
+        return $result;
+    }
+
+    $route = $request->get_route();
+
+    if ( empty( $route ) || ! str_contains( $route, 'buddypress/v1' ) ) {
+        return $result;
+    }
+
+    return new WP_Error(
+        'rest_no_route',
+        __( 'The V1 of the BuddyPress REST API is no longer supported, use the V2 instead.', 'buddypress' ),
+        array( 'status' => 404 )
+    );
+}
+add_filter( 'rest_pre_dispatch', 'bp_rest_api_v1_dispatch_error', 10, 3 );
+
+/**
+ * Register the jQuery.ajax wrapper for BP REST API requests.
+ *
+ * @since 5.0.0
+ * @deprecated 10.0.0
+ */
+function bp_rest_api_register_request_script() {
+    if ( ! bp_rest_api_is_available() ) {
+        return;
+    }
+
+    wp_register_script(
+        'bp-api-request',
+        sprintf( '%1$sbp-core/js/bp-api-request%2$s.js', buddypress()->plugin_url, bp_core_get_minified_asset_suffix() ),
+        array( 'jquery', 'wp-api-request' ),
+        bp_get_version(),
+        true
+    );
+
+    wp_localize_script(
+        'bp-api-request',
+        'bpApiSettings',
+        array(
+            'unexpectedError'   => __( 'An unexpected error occurred. Please try again.', 'buddypress' ),
+            'deprecatedWarning' => __( 'The bp.apiRequest function is deprecated since BuddyPress 10.0.0, please use wp.apiRequest instead.', 'buddypress' ),
+        )
+    );
+}
+add_action( 'bp_init', 'bp_rest_api_register_request_script' );