Changeset 53183

Timestamp:

04/14/2022 03:13:45 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Rename the $object variable to $attachment in several files.

This brings some consistency with a similar fragment in Custom_Image_Heade::step_2_manage_upload(), WP_Site_Icon::insert_attachment(), media_handle_upload(), and clarifies the type of the data.

Follow-up to [52946], [53137].

See #55327, #54728.

Location:

trunk/src/wp-admin/includes

Files:

• ajax-actions.php (modified) (4 diffs)
• class-custom-background.php (modified) (2 diffs)
• class-custom-image-header.php (modified) (1 diff)
• class-file-upload-upgrader.php (modified) (2 diffs)
• import.php (modified) (2 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -3951 +3951 @@
 
                         /** This filter is documented in wp-admin/includes/class-custom-image-header.php */
-                        $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
-                        $object  = $wp_site_icon->create_attachment_object( $cropped, $attachment_id );
-                        unset( $object['ID'] );
+                        $cropped    = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
+                        $attachment = $wp_site_icon->create_attachment_object( $cropped, $attachment_id );
+                        unset( $attachment['ID'] );
 
                         // Update the attachment.
                         add_filter( 'intermediate_image_sizes_advanced', array( $wp_site_icon, 'additional_sizes' ) );
-                        $attachment_id = $wp_site_icon->insert_attachment( $object, $cropped );
+                        $attachment_id = $wp_site_icon->insert_attachment( $attachment, $cropped );
                         remove_filter( 'intermediate_image_sizes_advanced', array( $wp_site_icon, 'additional_sizes' ) );
 
@@ -3989 +3989 @@
 
                         // Get the original image's post to pre-populate the cropped image.
-                        $original_attachment      = get_post( $attachment_id );
-                        $sanitized_post_title     = sanitize_file_name( $original_attachment->post_title );
-                        $use_original_title       = (
+                        $original_attachment  = get_post( $attachment_id );
+                        $sanitized_post_title = sanitize_file_name( $original_attachment->post_title );
+                        $use_original_title   = (
                                 ( '' !== trim( $original_attachment->post_title ) ) &&
                                 /*
@@ -4002 +4002 @@
                         $use_original_description = ( '' !== trim( $original_attachment->post_content ) );
 
-                        $object = array(
+                        $attachment = array(
                                 'post_title'     => $use_original_title ? $original_attachment->post_title : wp_basename( $cropped ),
                                 'post_content'   => $use_original_description ? $original_attachment->post_content : $url,
@@ -4012 +4012 @@
                         // Copy the image caption attribute (post_excerpt field) from the original image.
                         if ( '' !== trim( $original_attachment->post_excerpt ) ) {
-                                $object['post_excerpt'] = $original_attachment->post_excerpt;
+                                $attachment['post_excerpt'] = $original_attachment->post_excerpt;
                         }
 
                         // Copy the image alt text attribute from the original image.
                         if ( '' !== trim( $original_attachment->_wp_attachment_image_alt ) ) {
-                                $object['meta_input'] = array(
+                                $attachment['meta_input'] = array(
                                         '_wp_attachment_image_alt' => wp_slash( $original_attachment->_wp_attachment_image_alt ),
                                 );
                         }
 
-                        $attachment_id = wp_insert_attachment( $object, $cropped );
+                        $attachment_id = wp_insert_attachment( $attachment, $cropped );
                         $metadata      = wp_generate_attachment_metadata( $attachment_id, $cropped );
 

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

@@ -511 +511 @@
                 $filename = wp_basename( $file );
 
-                // Construct the object array.
-                $object = array(
+                // Construct the attachment array.
+                $attachment = array(
                         'post_title'     => $filename,
                         'post_content'   => $url,
@@ -521 +521 @@
 
                 // Save the data.
-                $id = wp_insert_attachment( $object, $file );
+                $id = wp_insert_attachment( $attachment, $file );
 
                 // Add the metadata.

trunk/src/wp-admin/includes/class-custom-image-header.php

@@ -974 +974 @@
                 $filename = wp_basename( $file );
 
-                // Construct the array with attachment object data.
+                // Construct the attachment array.
                 $attachment = array(
                         'post_title'     => $filename,

trunk/src/wp-admin/includes/class-file-upload-upgrader.php

@@ -72 +72 @@
                         $this->package  = $file['file'];
 
-                        // Construct the object array.
-                        $object = array(
+                        // Construct the attachment array.
+                        $attachment = array(
                                 'post_title'     => $this->filename,
                                 'post_content'   => $file['url'],
@@ -83 +83 @@
 
                         // Save the data.
-                        $this->id = wp_insert_attachment( $object, $file['file'] );
+                        $this->id = wp_insert_attachment( $attachment, $file['file'] );
 
                         // Schedule a cleanup for 2 hours from now in case of failed installation.

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

@@ -104 +104 @@
         }
 
-        // Construct the object array.
-        $object = array(
+        // Construct the attachment array.
+        $attachment = array(
                 'post_title'     => wp_basename( $upload['file'] ),
                 'post_content'   => $upload['url'],
@@ -115 +115 @@
 
         // Save the data.
-        $id = wp_insert_attachment( $object, $upload['file'] );
+        $id = wp_insert_attachment( $attachment, $upload['file'] );
 
         /*