Changeset 11535 for sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api.php

Timestamp:

02/10/2022 12:41:19 AM (5 years ago)

Author:

dd32

Message:

Plugin Directory: API: Allow clients to disable the versions and download_link fields.

Full changes:

• Can disable the versions response key.
• Can disable the download_link response key.
• Incorrectly documented downloadlink key will affect the download_link key.
• Requesting reviews without sections will now result in sections.reviews being returned still
• Typos in documentation & code cleanup.

See #6032.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api.php (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/standalone/class-plugins-info-api.php

@@ -155 +155 @@
          * @param string $method   The requested method, used to determine the default fields to include.
          *
-         * @return array The $resonse with the extra fields removed.
-         */
-        protected function remove_unexpected_fields( $response, $request, $method = '' ) {
-                $fields = $request->get_expected_fields( $method );
+         * @return array The $response with the extra fields removed.
+         */
+        protected function remove_unexpected_fields( $full_response, $request, $method = '' ) {
+                $response = $full_response;
+                $fields   = $request->get_expected_fields( $method );
                 foreach ( $fields as $field => $include ) {
                         if ( ! $include ) {
@@ -168 +169 @@
                 }
 
+                // Support requesting reviews without sections.
+                if ( ! empty( $fields['reviews'] ) && empty( $fields['sections'] ) ) {
+                        $response['sections'] = array(
+                                'reviews' => $full_response['sections']['reviews']
+                        );
+                }
+
                 // Back-compatible routines.
                 // WordPress 4.9 and older need a "bare" contributor map [ user => profile ]
                 if ( ! empty( $fields['bare_contributors'] ) ) {
-                        $contribs                 = $response['contributors'] ?? [];
+                        $contributors             = $response['contributors'] ?? [];
                         $response['contributors'] = array();
-                        if ( $contribs ) {
-                                foreach ( $contribs as $user => $data ) {
-                                        $response['contributors'][ $user ] = $data['profile'];
-                                }
+                        foreach ( $contributors as $user => $data ) {
+                                $response['contributors'][ $user ] = $data['profile'];
                         }
                 }
@@ -182 +188 @@
                 // Only include block translation data for the selected locale.
                 if ( ! empty( $response['block_translations'] ) ) {
-                        $response['block_translations'] = !empty( $response['block_translations'][ $request->locale ] ) ? $response['block_translations'][ $request->locale ] : [];
+                        $response['block_translations'] = $response['block_translations'][ $request->locale ] ?? [];
                 }