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

Timestamp:

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

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

@@ -162 +162 @@
 
                 $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 autosaves of this post.' ), array( 'status' => rest_authorization_required_code() ) );
+                        return new WP_Error(
+                                'rest_cannot_read',
+                                __( 'Sorry, you are not allowed to view autosaves of this post.' ),
+                                array( 'status' => rest_authorization_required_code() )
+                        );
                 }
 
@@ -182 +187 @@
         public function create_item_permissions_check( $request ) {
                 $id = $request->get_param( 'id' );
+
                 if ( empty( $id ) ) {
-                        return new WP_Error( 'rest_post_invalid_id', __( 'Invalid item ID.' ), array( 'status' => 404 ) );
+                        return new WP_Error(
+                                'rest_post_invalid_id',
+                                __( 'Invalid item ID.' ),
+                                array( 'status' => 404 )
+                        );
                 }
 
@@ -215 +225 @@
                 if ( ( 'draft' === $post->post_status || 'auto-draft' === $post->post_status ) && $post->post_author == $user_id ) {
                         // Draft posts for the same author: autosaving updates the post and does not create a revision.
-                        // Convert the post object to an array and add slashes, wp_update_post expects escaped array.
+                        // Convert the post object to an array and add slashes, wp_update_post() expects escaped array.
                         $autosave_id = wp_update_post( wp_slash( (array) $prepared_post ), true );
                 } else {
@@ -247 +257 @@
 
                 if ( $parent_id <= 0 ) {
-                        return new WP_Error( 'rest_post_invalid_id', __( 'Invalid post parent ID.' ), array( 'status' => 404 ) );
+                        return new WP_Error(
+                                'rest_post_invalid_id',
+                                __( 'Invalid post parent ID.' ),
+                                array( 'status' => 404 )
+                        );
                 }
 
@@ -253 +267 @@
 
                 if ( ! $autosave ) {
-                        return new WP_Error( 'rest_post_no_autosave', __( 'There is no autosave revision for this post.' ), array( 'status' => 404 ) );
+                        return new WP_Error(
+                                'rest_post_no_autosave',
+                                __( 'There is no autosave revision for this post.' ),
+                                array( 'status' => 404 )
+                        );
                 }
 
@@ -314 +332 @@
 
                 $this->schema = $schema;
+
                 return $this->add_additional_fields_schema( $this->schema );
         }
@@ -358 +377 @@
                         if ( ! $autosave_is_different ) {
                                 wp_delete_post_revision( $old_autosave->ID );
-                                return new WP_Error( 'rest_autosave_no_changes', __( 'There is nothing to save. The autosave and the post content are the same.' ), array( 'status' => 400 ) );
+                                return new WP_Error(
+                                        'rest_autosave_no_changes',
+                                        __( 'There is nothing to save. The autosave and the post content are the same.' ),
+                                        array( 'status' => 400 )
+                                );
                         }
 
@@ -364 +387 @@
                         do_action( 'wp_creating_autosave', $new_autosave );
 
-                        // wp_update_post expects escaped array.
+                        // wp_update_post() expects escaped array.
                         return wp_update_post( wp_slash( $new_autosave ) );
                 }