Changeset 12463

Timestamp:

09/25/2019 11:22:00 PM (7 years ago)

Author:

imath

Message:

Improve the way BP REST API Controllers are loaded

Introduce a new filter to allow site owners to eventually disable one or more BP REST API Controllers.

See #7156

Location:

trunk

Files:

• src/bp-activity/classes/class-bp-activity-component.php (modified) (1 diff)
• src/bp-core/classes/class-bp-component.php (modified) (1 diff)
• src/bp-groups/classes/class-bp-groups-component.php (modified) (1 diff)
• src/bp-members/classes/class-bp-members-component.php (modified) (1 diff)
• src/bp-messages/classes/class-bp-messages-component.php (modified) (1 diff)
• src/bp-notifications/classes/class-bp-notifications-component.php (modified) (1 diff)
• src/bp-xprofile/classes/class-bp-xprofile-component.php (modified) (1 diff)
• tests/phpunit/assets/bp-rest-api-controllers.php (added)
• tests/phpunit/testcases/core/class-bp-component.php (added)

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

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

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

@@ -868 +868 @@
          *
          * @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();
+                        }
+                }
 
                 /**

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

@@ -928 +928 @@
          *
          * @since 5.0.0
-         */
-        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();
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
+         */
+        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',
+                ) );
         }
 }

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

@@ -462 +462 @@
          *
          * @since 5.0.0
-         */
-        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();
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
+         */
+        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',
+                ) );
         }
 }

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

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

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

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

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

@@ -495 +495 @@
          *
          * @since 5.0.0
-         */
-        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();
+         *
+         * @param array $controllers Optional. See BP_Component::rest_api_init() for
+         *                           description.
+         */
+        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',
+                ) );
         }
 }