Changeset 14026 for trunk/src/bp-core/classes/class-bp-component.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/classes/class-bp-component.php (modified) (6 diffs)

trunk/src/bp-core/classes/class-bp-component.php

@@ -247 +247 @@
      *
      * @param string $id   Unique ID. Letters, numbers, and underscores only.
-     * @param string $name Unique name. This should be a translatable name, eg.
-     *                     __( 'Groups', 'buddypress' ).
+     * @param string $name Unique name. This should be a translatable name, e.g. __( 'Groups', 'buddypress' ).
      * @param string $path The file path for the component's files. Used by {@link BP_Component::includes()}.
      * @param array  $params {
@@ -314 +313 @@
      *                                           if one is found, otherwise an empty string.
      *     @type bool     $has_directory         Set to true if the component requires an associated WordPress page.
-     *     @type array    $rewrite_ids           The list of rewrited IDs to use for the component.
+     *     @type array    $rewrite_ids           The list of rewritten IDs to use for the component.
      *     @type string   $directory_title       The title to use for the directory page.
      *     @type callable $notification_callback The callable function that formats the component's notifications.
@@ -530 +529 @@
 
                 foreach ( $paths as $path ) {
+
                     if ( @is_file( $slashed_path . $path ) ) {
                         require $slashed_path . $path;
@@ -623 +623 @@
         // Register BP REST Endpoints.
         if ( bp_rest_in_buddypress() && bp_rest_api_is_available() ) {
-            add_action( 'bp_rest_api_init', array( $this, 'rest_api_init' ), 10 );
+            add_action( 'bp_rest_api_init', array( $this, 'rest_api_init' ) );
         }
 
@@ -1416 +1416 @@
              * @since 5.0.0
              *
-             * @param array $controllers The list of BP REST API controllers to load.
+             * @param string[] $controllers The list of BP REST API controllers to load.
              */
             $controllers = (array) apply_filters( 'bp_' . $this->id . '_rest_api_controllers', $controllers );
@@ -1425 +1425 @@
                 }
 
+                if ( ! class_exists( $controller ) ) {
+                    _doing_it_wrong(
+                        __METHOD__,
+                        sprintf(
+                            // translators: %s: REST API controller class name.
+                            esc_html__( 'The REST API controller class %s does not exist.', 'buddypress' ),
+                            esc_attr( $controller )
+                        ),
+                        '15.0.0'
+                    );
+                }
+
                 $component_controller = new $controller();
                 $component_controller->register_routes();