Changeset 47122 for trunk/src/wp-admin/includes/class-custom-background.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-admin/includes/class-custom-background.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-custom-background.php

@@ -125 +125 @@
 
                 if ( isset( $_POST['remove-background'] ) ) {
-                        // @TODO: Uploaded files are not removed here.
+                        // @todo Uploaded files are not removed here.
                         check_admin_referer( 'custom-background-remove', '_wpnonce-custom-background-remove' );
                         set_theme_mod( 'background_image', '' );
@@ -285 +285 @@
                         }
                         ?>
-        <div id="custom-background-image" style="<?php echo $background_styles; ?>"><?php // must be double quote, see above ?>
+        <div id="custom-background-image" style="<?php echo $background_styles; ?>"><?php // Must be double quote, see above. ?>
                         <?php if ( $background_image_thumb ) { ?>
                 <img class="custom-background-image" src="<?php echo $background_image_thumb; ?>" style="visibility:hidden;" alt="" /><br />
@@ -504 +504 @@
                 $filename = wp_basename( $file );
 
-                // Construct the object array
+                // Construct the object array.
                 $object = array(
                         'post_title'     => $filename,
@@ -513 +513 @@
                 );
 
-                // Save the data
+                // Save the data.
                 $id = wp_insert_attachment( $object, $file );
 
-                // Add the meta-data
+                // Add the metadata.
                 wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) );
                 update_post_meta( $id, '_wp_attachment_is_custom_background', get_option( 'stylesheet' ) );
@@ -526 +526 @@
 
                 /** This action is documented in wp-admin/includes/class-custom-image-header.php */
-                do_action( 'wp_create_file_in_uploads', $file, $id ); // For replication
+                do_action( 'wp_create_file_in_uploads', $file, $id ); // For replication.
                 $this->updated = true;
         }