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

Timestamp:

01/29/2020 12:43:23 AM (6 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-revisions-controller.php (modified) (11 diffs)

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

@@ -139 +139 @@
      */
     protected function get_parent( $parent ) {
-        $error = new WP_Error( 'rest_post_invalid_parent', __( 'Invalid post parent ID.' ), array( 'status' => 404 ) );
+        $error = new WP_Error(
+            'rest_post_invalid_parent',
+            __( 'Invalid post parent ID.' ),
+            array( 'status' => 404 )
+        );
         if ( (int) $parent <= 0 ) {
             return $error;
@@ -167 +171 @@
 
         $parent_post_type_obj = get_post_type_object( $parent->post_type );
+
         if ( ! current_user_can( $parent_post_type_obj->cap->edit_post, $parent->ID ) ) {
-            return new WP_Error( 'rest_cannot_read', __( 'Sorry, you are not allowed to view revisions of this post.' ), array( 'status' => rest_authorization_required_code() ) );
+            return new WP_Error(
+                'rest_cannot_read',
+                __( 'Sorry, you are not allowed to view revisions of this post.' ),
+                array( 'status' => rest_authorization_required_code() )
+            );
         }
 
@@ -183 +192 @@
      */
     protected function get_revision( $id ) {
-        $error = new WP_Error( 'rest_post_invalid_id', __( 'Invalid revision ID.' ), array( 'status' => 404 ) );
+        $error = new WP_Error(
+            'rest_post_invalid_id',
+            __( 'Invalid revision ID.' ),
+            array( 'status' => 404 )
+        );
+
         if ( (int) $id <= 0 ) {
             return $error;
@@ -212 +226 @@
         // Ensure a search string is set in case the orderby is set to 'relevance'.
         if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) {
-            return new WP_Error( 'rest_no_search_term_defined', __( 'You need to define a search term to order by relevance.' ), array( 'status' => 400 ) );
+            return new WP_Error(
+                'rest_no_search_term_defined',
+                __( 'You need to define a search term to order by relevance.' ),
+                array( 'status' => 400 )
+            );
         }
 
         // Ensure an include parameter is set in case the orderby is set to 'include'.
         if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) {
-            return new WP_Error( 'rest_orderby_include_missing_include', __( 'You need to define an include parameter to order by include.' ), array( 'status' => 400 ) );
+            return new WP_Error(
+                'rest_orderby_include_missing_include',
+                __( 'You need to define an include parameter to order by include.' ),
+                array( 'status' => 400 )
+            );
         }
 
@@ -282 +304 @@
             if ( $total_revisions > 0 ) {
                 if ( $offset >= $total_revisions ) {
-                    return new WP_Error( 'rest_revision_invalid_offset_number', __( 'The offset number requested is larger than or equal to the number of available revisions.' ), array( 'status' => 400 ) );
+                    return new WP_Error(
+                        'rest_revision_invalid_offset_number',
+                        __( 'The offset number requested is larger than or equal to the number of available revisions.' ),
+                        array( 'status' => 400 )
+                    );
                 } elseif ( ! $offset && $page > $max_pages ) {
-                    return new WP_Error( 'rest_revision_invalid_page_number', __( 'The page number requested is larger than the number of pages available.' ), array( 'status' => 400 ) );
+                    return new WP_Error(
+                        'rest_revision_invalid_page_number',
+                        __( 'The page number requested is larger than the number of pages available.' ),
+                        array( 'status' => 400 )
+                    );
                 }
             }
@@ -295 +325 @@
 
         $response = array();
+
         foreach ( $revisions as $revision ) {
             $data       = $this->prepare_item_for_response( $revision, $request );
@@ -355 +386 @@
 
         $parent_post_type = get_post_type_object( $parent->post_type );
+
         if ( ! current_user_can( $parent_post_type->cap->delete_post, $parent->ID ) ) {
-            return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete revisions of this post.' ), array( 'status' => rest_authorization_required_code() ) );
+            return new WP_Error(
+                'rest_cannot_delete',
+                __( 'Sorry, you are not allowed to delete revisions of this post.' ),
+                array( 'status' => rest_authorization_required_code() )
+            );
         }
 
@@ -395 +431 @@
 
         if ( ! current_user_can( $post_type->cap->delete_post, $revision->ID ) ) {
-            return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this revision.' ), array( 'status' => rest_authorization_required_code() ) );
+            return new WP_Error(
+                'rest_cannot_delete',
+                __( 'Sorry, you are not allowed to delete this revision.' ),
+                array( 'status' => rest_authorization_required_code() )
+            );
         }
 
@@ -419 +459 @@
         // We don't support trashing for revisions.
         if ( ! $force ) {
-            /* translators: %s: force=true */
-            return new WP_Error( 'rest_trash_not_supported', sprintf( __( "Revisions do not support trashing. Set '%s' to delete." ), 'force=true' ), array( 'status' => 501 ) );
+            return new WP_Error(
+                'rest_trash_not_supported',
+                /* translators: %s: force=true */
+                sprintf( __( "Revisions do not support trashing. Set '%s' to delete." ), 'force=true' ),
+                array( 'status' => 501 )
+            );
         }
 
@@ -440 +484 @@
 
         if ( ! $result ) {
-            return new WP_Error( 'rest_cannot_delete', __( 'The post cannot be deleted.' ), array( 'status' => 500 ) );
+            return new WP_Error(
+                'rest_cannot_delete',
+                __( 'The post cannot be deleted.' ),
+                array( 'status' => 500 )
+            );
         }
 
@@ -702 +750 @@
 
         $this->schema = $schema;
+
         return $this->add_additional_fields_schema( $this->schema );
     }