Ticket #7156: 7156.4.patch

src/bp-activity/classes/class-bp-activity-component.php

@@ -461 +461 @@
          * Init the BP REST API.
          *
          * @since 5.0.0
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
          */
-        public function rest_api_init() {
-                $controller = new BP_REST_Activity_Endpoint();
-                $controller->register_routes();
-
-                parent::rest_api_init();
+        public function rest_api_init( $controllers = array() ) {
+                parent::rest_api_init( array( 'BP_REST_Activity_Endpoint' ) );
         }
 }

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

@@ -867 +867 @@
          * Init the BP REST API.
          *
          * @since 5.0.0
-         */
-        public function rest_api_init() {
+         *
+         * @param array $controllers The list of BP REST controllers to load.
+         */
+        public function rest_api_init( $controllers = array() ) {
+                if ( is_array( $controllers ) && $controllers ) {
+                        // Built-in controllers.
+                        $_controllers = $controllers;
+
+                        /**
+                         * Use this filter to disable all or some REST API controllers
+                         * for the component.
+                         *
+                         * This is a dynamic hook that is based on the component string ID.
+                         *
+                         * @since 5.0.0
+                         *
+                         * @param array $controllers The list of BP REST API controllers to load.
+                         */
+                        $controllers = (array) apply_filters( 'bp_' . $this->id . '_rest_api_controllers', $controllers );
+
+                        foreach( $controllers as $controller ) {
+                                if ( ! in_array( $controller, $_controllers, true ) ) {
+                                        continue;
+                                }
+
+                                $component_controller = new $controller;
+                                $component_controller->register_routes();
+                        }
+                }
 
                 /**
                  * Fires in the rest_api_init method inside BP_Component.

src/bp-groups/classes/class-bp-groups-component.php

@@ -927 +927 @@
          * Init the BP REST API.
          *
          * @since 5.0.0
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
          */
-        public function rest_api_init() {
-                $controller = new BP_REST_Groups_Endpoint();
-                $controller->register_routes();
-
-                $controller = new BP_REST_Group_Membership_Endpoint();
-                $controller->register_routes();
-
-                $controller = new BP_REST_Group_Invites_Endpoint();
-                $controller->register_routes();
-
-                $controller = new BP_REST_Group_Membership_Request_Endpoint();
-                $controller->register_routes();
-
-                $controller = new BP_REST_Attachments_Group_Avatar_Endpoint();
-                $controller->register_routes();
-
-                parent::rest_api_init();
+        public function rest_api_init( $controllers = array() ) {
+                parent::rest_api_init( array(
+                        'BP_REST_Groups_Endpoint',
+                        'BP_REST_Group_Membership_Endpoint',
+                        'BP_REST_Group_Invites_Endpoint',
+                        'BP_REST_Group_Membership_Request_Endpoint',
+                        'BP_REST_Attachments_Group_Avatar_Endpoint',
+                ) );
         }
 }

src/bp-members/classes/class-bp-members-component.php

@@ -461 +461 @@
          * Init the BP REST API.
          *
          * @since 5.0.0
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
          */
-        public function rest_api_init() {
-                /**
-                 * As the Members component is always loaded,
-                 * let's register the Components endpoint here.
-                 */
-                $controller = new BP_REST_Components_Endpoint();
-                $controller->register_routes();
-
-                $controller = new BP_REST_Members_Endpoint();
-                $controller->register_routes();
-
-                $controller = new BP_REST_Attachments_Member_Avatar_Endpoint();
-                $controller->register_routes();
-
-                parent::rest_api_init();
+        public function rest_api_init( $controllers = array() ) {
+                parent::rest_api_init( array(
+                        /**
+                         * As the Members component is always loaded,
+                         * let's register the Components endpoint here.
+                         */
+                        'BP_REST_Components_Endpoint',
+                        'BP_REST_Members_Endpoint',
+                        'BP_REST_Attachments_Member_Avatar_Endpoint',
+                ) );
         }
 }

src/bp-messages/classes/class-bp-messages-component.php

@@ -438 +438 @@
          * Init the BP REST API.
          *
          * @since 5.0.0
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
          */
-        public function rest_api_init() {
-                $controller = new BP_REST_Messages_Endpoint();
-                $controller->register_routes();
-
-                parent::rest_api_init();
+        public function rest_api_init( $controllers = array() ) {
+                parent::rest_api_init( array( 'BP_REST_Messages_Endpoint' ) );
         }
 }

src/bp-notifications/classes/class-bp-notifications-component.php

@@ -320 +320 @@
          * Init the BP REST API.
          *
          * @since 5.0.0
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
          */
-        public function rest_api_init() {
-                $controller = new BP_REST_Notifications_Endpoint();
-                $controller->register_routes();
-
-                parent::rest_api_init();
+        public function rest_api_init( $controllers = array() ) {
+                parent::rest_api_init( array( 'BP_REST_Notifications_Endpoint' ) );
         }
 }

src/bp-xprofile/classes/class-bp-xprofile-component.php

@@ -494 +494 @@
          * Init the BP REST API.
          *
          * @since 5.0.0
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
          */
-        public function rest_api_init() {
-                $controller = new BP_REST_XProfile_Fields_Endpoint();
-                $controller->register_routes();
-
-                $controller = new BP_REST_XProfile_Field_Groups_Endpoint();
-                $controller->register_routes();
-
-                $controller = new BP_REST_XProfile_Data_Endpoint();
-                $controller->register_routes();
-
-                parent::rest_api_init();
+        public function rest_api_init( $controllers = array() ) {
+                parent::rest_api_init( array(
+                        'BP_REST_XProfile_Fields_Endpoint',
+                        'BP_REST_XProfile_Field_Groups_Endpoint',
+                        'BP_REST_XProfile_Data_Endpoint',
+                ) );
         }
 }

new file tests/phpunit/assets/bp-rest-api-controllers.php

@@ +1 @@
+<?php
+/**
+ * BP REST Controllers' mocks
+ */
+
+class BP_REST_Mock_Class {
+        public function __construct() {}
+
+        public function register_routes( $controller = '' ) {
+                array_push( buddypress()->unit_test_rest->controllers, $controller );
+        }
+}
+
+/**
+ * BP Member Avatar REST Controller's mock.
+ */
+class BP_REST_Attachments_Member_Avatar_Endpoint extends BP_REST_Mock_Class {
+        public function __construct() {
+                $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+                $this->rest_base = 'members';
+    }
+
+    public function register_routes( $controller = '' ) {
+                parent::register_routes( 'BP_REST_Attachments_Member_Avatar_Endpoint' );
+        }
+}
+
+/**
+ * BP Components REST Controller's mock.
+ */
+class BP_REST_Components_Endpoint extends BP_REST_Mock_Class {
+        public function __construct() {
+                $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+                $this->rest_base = 'components';
+    }
+
+    public function register_routes( $controller = '' ) {
+                parent::register_routes( 'BP_REST_Components_Endpoint' );
+        }
+}
+
+/**
+ * BP Members REST Controller's mock.
+ */
+class BP_REST_Members_Endpoint extends BP_REST_Mock_Class {
+        public function __construct() {
+                $this->namespace = bp_rest_namespace() . '/' . bp_rest_version();
+                $this->rest_base = 'members';
+    }
+
+    public function register_routes( $controller = '' ) {
+                parent::register_routes( 'BP_REST_Members_Endpoint' );
+        }
+}

new file tests/phpunit/testcases/core/class-bp-component.php

@@ +1 @@
+<?php
+
+include_once BP_TESTS_DIR . '/assets/bp-rest-api-controllers.php';
+
+/**
+ * @group core
+ * @group BP_Component
+ */
+class BP_Tests_BP_Component_TestCases extends BP_UnitTestCase {
+    public function setUp() {
+                parent::setUp();
+
+                $bp = buddypress();
+        $bp->unit_test_rest = new stdClass;
+        $bp->unit_test_rest->controllers = array();
+    }
+
+    public function remove_controller( $controllers ) {
+        return array_diff( $controllers, array( 'BP_REST_Members_Endpoint' ) );
+    }
+
+    public function add_controller( $controllers ) {
+        return array_merge( $controllers, array( 'Foo_Bar' ) );
+    }
+
+    public function test_rest_api_init_for_members_component() {
+        $bp_members = new BP_Members_Component();
+        $bp         = buddypress();
+
+        $bp_members->rest_api_init();
+
+        $this->assertSame( $bp->unit_test_rest->controllers, array(
+                        'BP_REST_Components_Endpoint',
+                        'BP_REST_Members_Endpoint',
+                        'BP_REST_Attachments_Member_Avatar_Endpoint',
+                ) );
+    }
+
+    public function test_rest_api_init_for_members_component_can_remove_controller() {
+        $bp_members = new BP_Members_Component();
+        $bp         = buddypress();
+
+        add_filter( 'bp_members_rest_api_controllers', array( $this, 'remove_controller' ) );
+
+        $bp_members->rest_api_init();
+
+        remove_filter( 'bp_members_rest_api_controllers', array( $this, 'remove_controller' ) );
+
+        $this->assertSame( $bp->unit_test_rest->controllers, array(
+                        'BP_REST_Components_Endpoint',
+                        'BP_REST_Attachments_Member_Avatar_Endpoint',
+                ) );
+    }
+
+    public function test_rest_api_init_for_members_component_cannot_add_controller() {
+        $bp_members = new BP_Members_Component();
+        $bp         = buddypress();
+
+        add_filter( 'bp_members_rest_api_controllers', array( $this, 'add_controller' ) );
+
+        $bp_members->rest_api_init();
+
+        remove_filter( 'bp_members_rest_api_controllers', array( $this, 'add_controller' ) );
+
+        $this->assertSame( $bp->unit_test_rest->controllers, array(
+                        'BP_REST_Components_Endpoint',
+                        'BP_REST_Members_Endpoint',
+                        'BP_REST_Attachments_Member_Avatar_Endpoint',
+                ) );
+    }
+}