Changeset 56193 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

Timestamp:

07/10/2023 10:58:33 PM (3 years ago)

Author:

audrasjb

Message:

Docs: Replace multiple single line comments with multi-line comments.

This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.

Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192].

Props costdev, audrasjb.
See #58459.

File:

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

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

@@ -203 +203 @@
 
                 if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
-                        // Set a custom header with the attachment_id.
-                        // Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
+                        /*
+                         * Set a custom header with the attachment_id.
+                         * Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
+                         */
                         header( 'X-WP-Upload-Attachment-ID: ' . $attachment_id );
                 }
@@ -212 +214 @@
                 require_once ABSPATH . 'wp-admin/includes/image.php';
 
-                // Post-process the upload (create image sub-sizes, make PDF thumbnails, etc.) and insert attachment meta.
-                // At this point the server may run out of resources and post-processing of uploaded images may fail.
+                /*
+                 * Post-process the upload (create image sub-sizes, make PDF thumbnails, etc.) and insert attachment meta.
+                 * At this point the server may run out of resources and post-processing of uploaded images may fail.
+                 */
                 wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );
 
@@ -563 +567 @@
                 $image_name = wp_basename( $image_file, ".{$image_ext}" );
 
-                // Do not append multiple `-edited` to the file name.
-                // The user may be editing a previously edited image.
+                /*
+                 * Do not append multiple `-edited` to the file name.
+                 * The user may be editing a previously edited image.
+                 */
                 if ( preg_match( '/-edited(-\d+)?$/', $image_name ) ) {
                         // Remove any `-1`, `-2`, etc. `wp_unique_filename()` will add the proper number.
@@ -626 +632 @@
 
                 if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
-                        // Set a custom header with the attachment_id.
-                        // Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
+                        /*
+                         * Set a custom header with the attachment_id.
+                         * Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
+                         */
                         header( 'X-WP-Upload-Attachment-ID: ' . $new_attachment_id );
                 }