Changeset 47122 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php (modified) (8 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

@@ -69 +69 @@
         foreach ( $search_handlers as $search_handler ) {
             if ( ! $search_handler instanceof WP_REST_Search_Handler ) {
-
-                /* translators: %s: PHP class name. */
-                _doing_it_wrong( __METHOD__, sprintf( __( 'REST search handlers must extend the %s class.' ), 'WP_REST_Search_Handler' ), '5.0.0' );
+                _doing_it_wrong(
+                    __METHOD__,
+                    /* translators: %s: PHP class name. */
+                    sprintf( __( 'REST search handlers must extend the %s class.' ), 'WP_REST_Search_Handler' ),
+                    '5.0.0'
+                );
                 continue;
             }
@@ -131 +134 @@
 
         if ( ! isset( $result[ WP_REST_Search_Handler::RESULT_IDS ] ) || ! is_array( $result[ WP_REST_Search_Handler::RESULT_IDS ] ) || ! isset( $result[ WP_REST_Search_Handler::RESULT_TOTAL ] ) ) {
-            return new WP_Error( 'rest_search_handler_error', __( 'Internal search handler error.' ), array( 'status' => 500 ) );
+            return new WP_Error(
+                'rest_search_handler_error',
+                __( 'Internal search handler error.' ),
+                array( 'status' => 500 )
+            );
         }
 
@@ -137 +144 @@
 
         $results = array();
+
         foreach ( $ids as $id ) {
             $data      = $this->prepare_item_for_response( $id, $request );
@@ -148 +156 @@
 
         if ( $page > $max_pages && $total > 0 ) {
-            return new WP_Error( 'rest_search_invalid_page_number', __( 'The page number requested is larger than the number of pages available.' ), array( 'status' => 400 ) );
+            return new WP_Error(
+                'rest_search_invalid_page_number',
+                __( 'The page number requested is larger than the number of pages available.' ),
+                array( 'status' => 400 )
+            );
         }
 
@@ -218 +230 @@
         $types    = array();
         $subtypes = array();
+
         foreach ( $this->search_handlers as $search_handler ) {
             $types[]  = $search_handler->get_type();
@@ -268 +281 @@
 
         $this->schema = $schema;
+
         return $this->add_additional_fields_schema( $this->schema );
     }
@@ -281 +295 @@
         $types    = array();
         $subtypes = array();
+
         foreach ( $this->search_handlers as $search_handler ) {
             $types[]  = $search_handler->get_type();
@@ -357 +372 @@
 
         if ( ! $type || ! isset( $this->search_handlers[ $type ] ) ) {
-            return new WP_Error( 'rest_search_invalid_type', __( 'Invalid type parameter.' ), array( 'status' => 400 ) );
+            return new WP_Error(
+                'rest_search_invalid_type',
+                __( 'Invalid type parameter.' ),
+                array( 'status' => 400 )
+            );
         }