Changeset 52946

Timestamp:

03/17/2022 08:17:48 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/class-custom-image-header.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit renames the $object variable in Custom_Image_Header class methods to $attachment for clarity and consistency, as the variable type is actually an array, and updates the documentation accordingly.

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.

File:

• trunk/src/wp-admin/includes/class-custom-image-header.php (modified) (10 diffs)

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

@@ -976 +976 @@
         $filename = wp_basename( $file );
 
-        // Construct the object array.
-        $object = array(
+        // Construct the array with attachment object data.
+        $attachment = array(
             'post_title'     => $filename,
             'post_content'   => $url,
@@ -986 +986 @@
 
         // Save the data.
-        $attachment_id = wp_insert_attachment( $object, $file );
+        $attachment_id = wp_insert_attachment( $attachment, $file );
 
         return compact( 'attachment_id', 'file', 'filename', 'url', 'type' );
@@ -1062 +1062 @@
         $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
 
-        $object = $this->create_attachment_object( $cropped, $attachment_id );
+        $attachment = $this->create_attachment_object( $cropped, $attachment_id );
 
         if ( ! empty( $_POST['create-new-attachment'] ) ) {
-            unset( $object['ID'] );
+            unset( $attachment['ID'] );
         }
 
         // Update the attachment.
-        $attachment_id = $this->insert_attachment( $object, $cropped );
+        $attachment_id = $this->insert_attachment( $attachment, $cropped );
 
         $url = wp_get_attachment_url( $attachment_id );
@@ -1301 +1301 @@
      * @param string $cropped              Cropped image URL.
      * @param int    $parent_attachment_id Attachment ID of parent image.
-     * @return array Attachment object.
+     * @return array An array with attachment object data.
      */
     final public function create_attachment_object( $cropped, $parent_attachment_id ) {
@@ -1311 +1311 @@
         $image_type = ( $size ) ? $size['mime'] : 'image/jpeg';
 
-        $object = array(
+        $attachment = array(
             'ID'             => $parent_attachment_id,
             'post_title'     => wp_basename( $cropped ),
@@ -1320 +1320 @@
         );
 
-        return $object;
+        return $attachment;
     }
 
@@ -1328 +1328 @@
      * @since 3.9.0
      *
-     * @param array  $object  Attachment object.
-     * @param string $cropped File path to cropped image.
+     * @param array  $attachment An array with attachment object data.
+     * @param string $cropped    File path to cropped image.
      * @return int Attachment ID.
      */
-    final public function insert_attachment( $object, $cropped ) {
-        $parent_id = isset( $object['post_parent'] ) ? $object['post_parent'] : null;
-        unset( $object['post_parent'] );
-
-        $attachment_id = wp_insert_attachment( $object, $cropped );
+    final public function insert_attachment( $attachment, $cropped ) {
+        $parent_id = isset( $attachment['post_parent'] ) ? $attachment['post_parent'] : null;
+        unset( $attachment['post_parent'] );
+
+        $attachment_id = wp_insert_attachment( $attachment, $cropped );
         $metadata      = wp_generate_attachment_metadata( $attachment_id, $cropped );
 
@@ -1405 +1405 @@
         $cropped = apply_filters( 'wp_create_file_in_uploads', $cropped, $attachment_id ); // For replication.
 
-        $object = $this->create_attachment_object( $cropped, $attachment_id );
-
-        $previous = $this->get_previous_crop( $object );
+        $attachment = $this->create_attachment_object( $cropped, $attachment_id );
+
+        $previous = $this->get_previous_crop( $attachment );
 
         if ( $previous ) {
-            $object['ID'] = $previous;
+            $attachment['ID'] = $previous;
         } else {
-            unset( $object['ID'] );
-        }
-
-        $new_attachment_id = $this->insert_attachment( $object, $cropped );
-
-        $object['attachment_id'] = $new_attachment_id;
-        $object['url']           = wp_get_attachment_url( $new_attachment_id );
-
-        $object['width']  = $dimensions['dst_width'];
-        $object['height'] = $dimensions['dst_height'];
-
-        wp_send_json_success( $object );
+            unset( $attachment['ID'] );
+        }
+
+        $new_attachment_id = $this->insert_attachment( $attachment, $cropped );
+
+        $attachment['attachment_id'] = $new_attachment_id;
+        $attachment['url']           = wp_get_attachment_url( $new_attachment_id );
+
+        $attachment['width']  = $dimensions['dst_width'];
+        $attachment['height'] = $dimensions['dst_height'];
+
+        wp_send_json_success( $attachment );
     }
 
@@ -1578 +1578 @@
      * @since 4.9.0
      *
-     * @param array $object A crop attachment object.
+     * @param array $attachment An array with a cropped attachment object data.
      * @return int|false An attachment ID if one exists. False if none.
      */
-    public function get_previous_crop( $object ) {
+    public function get_previous_crop( $attachment ) {
         $header_images = $this->get_uploaded_header_images();
 
@@ -1592 +1592 @@
 
         foreach ( $header_images as $image ) {
-            if ( $image['attachment_parent'] === $object['post_parent'] ) {
+            if ( $image['attachment_parent'] === $attachment['post_parent'] ) {
                 $previous = $image['attachment_id'];
                 break;