Changeset 47084 for trunk/src/wp-admin/includes/media.php

Timestamp:

01/18/2020 12:52:28 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve comments in some wp-admin files per the documentation standards.

Props passoniate.
Fixes #49215, #49216.

File:

• trunk/src/wp-admin/includes/media.php (modified) (13 diffs)

trunk/src/wp-admin/includes/media.php

@@ -16 +16 @@
 function media_upload_tabs() {
     $_default_tabs = array(
-        'type'     => __( 'From Computer' ), // handler action suffix => tab text
+        'type'     => __( 'From Computer' ), // Handler action suffix => tab text.
         'type_url' => __( 'From URL' ),
         'gallery'  => __( 'Gallery' ),
@@ -227 +227 @@
     $caption = preg_replace_callback( '/<[a-zA-Z0-9]+(?: [^<>]+>)*/', '_cleanup_image_add_caption', $caption );
 
-    // Convert any remaining line breaks to <br>.
+    // Convert any remaining line breaks to <br />.
     $caption = preg_replace( '/[ \n\t]*\n[ \t]*/', '<br />', $caption );
 
@@ -389 +389 @@
     }
 
-    // Construct the attachment array
+    // Construct the attachment array.
     $attachment = array_merge(
         array(
@@ -405 +405 @@
     unset( $attachment['ID'] );
 
-    // Save the data
+    // Save the data.
     $attachment_id = wp_insert_attachment( $attachment, $file, $post_id, true );
 
@@ -491 +491 @@
     unset( $attachment['ID'] );
 
-    // Save the attachment metadata
+    // Save the attachment metadata.
     $attachment_id = wp_insert_attachment( $attachment, $file, $post_id, true );
 
@@ -520 +520 @@
 
     wp_enqueue_style( 'colors' );
-    // Check callback name for 'media'
+    // Check callback name for 'media'.
     if (
         ( is_array( $content_func ) && ! empty( $content_func[1] ) && 0 === strpos( (string) $content_func[1], 'media' ) ) ||
@@ -850 +850 @@
     if ( isset( $_POST['html-upload'] ) && ! empty( $_FILES ) ) {
         check_admin_referer( 'media-form' );
-        // Upload File button was clicked
+        // Upload File button was clicked.
         $id = media_handle_upload( 'async-upload', $_REQUEST['post_id'] );
         unset( $_FILES );
@@ -1422 +1422 @@
     }
 
-    // Merge default fields with their errors, so any key passed with the error (e.g. 'error', 'helps', 'value') will replace the default
-    // The recursive merge is easily traversed with array casting: foreach ( (array) $things as $thing )
+    /*
+     * Merge default fields with their errors, so any key passed with the error
+     * (e.g. 'error', 'helps', 'value') will replace the default.
+     * The recursive merge is easily traversed with array casting:
+     * foreach ( (array) $things as $thing )
+     */
     $form_fields = array_merge_recursive( $form_fields, (array) $errors );
 
@@ -1597 +1601 @@
     }
 
-    $display_title = ( ! empty( $title ) ) ? $title : $filename; // $title shouldn't ever be empty, but just in case
+    $display_title = ( ! empty( $title ) ) ? $title : $filename; // $title shouldn't ever be empty, but just in case.
     $display_title = $parsed_args['show_title'] ? "<div class='filename new'><span class='title'>" . wp_html_excerpt( $display_title, 60, '&hellip;' ) . '</span></div>' : '';
 
@@ -1711 +1715 @@
     if ( isset( $_GET['post_id'] ) ) {
         $calling_post_id = absint( $_GET['post_id'] );
-    } elseif ( isset( $_POST ) && count( $_POST ) ) {// Like for async-upload where $_GET['post_id'] isn't set
+    } elseif ( isset( $_POST ) && count( $_POST ) ) {// Like for async-upload where $_GET['post_id'] isn't set.
         $calling_post_id = $post->post_parent;
     }
@@ -1876 +1880 @@
     }
 
-    // Merge default fields with their errors, so any key passed with the error (e.g. 'error', 'helps', 'value') will replace the default
-    // The recursive merge is easily traversed with array casting: foreach ( (array) $things as $thing )
+    /*
+     * Merge default fields with their errors, so any key passed with the error
+     * (e.g. 'error', 'helps', 'value') will replace the default.
+     * The recursive merge is easily traversed with array casting:
+     * foreach ( (array) $things as $thing )
+     */
     $form_fields = array_merge_recursive( $form_fields, (array) $args['errors'] );
 
@@ -2133 +2141 @@
     );
 
-    // Currently only iOS Safari supports multiple files uploading but iOS 7.x has a bug that prevents uploading of videos
-    // when enabled. See #29602.
+    /*
+     * Currently only iOS Safari supports multiple files uploading,
+     * but iOS 7.x has a bug that prevents uploading of videos when enabled.
+     * See #29602.
+     */
     if (
         wp_is_mobile() &&
@@ -2701 +2712 @@
             }
         }
-        // If available type specified by media button clicked, filter by that type
+        // If available type specified by media button clicked, filter by that type.
         if ( empty( $_GET['post_mime_type'] ) && ! empty( $num_posts[ $type ] ) ) {
             $_GET['post_mime_type']                        = $type;