Changeset 53137 for trunk/src/wp-admin/includes/class-wp-site-icon.php

Timestamp:

04/11/2022 02:19:13 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/class-wp-site-icon.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 to $attachment in WP_Site_Icon::insert_attachment() and updates the documentation accordingly.

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117].

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

File:

• trunk/src/wp-admin/includes/class-wp-site-icon.php (modified) (4 diffs)

trunk/src/wp-admin/includes/class-wp-site-icon.php

@@ -81 +81 @@
      * @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.
      */
     public function create_attachment_object( $cropped, $parent_attachment_id ) {
@@ -91 +91 @@
         $image_type = ( $size ) ? $size['mime'] : 'image/jpeg';
 
-        $object = array(
+        $attachment = array(
             'ID'             => $parent_attachment_id,
             'post_title'     => wp_basename( $cropped ),
@@ -100 +100 @@
         );
 
-        return $object;
+        return $attachment;
     }
 
@@ -108 +108 @@
      * @since 4.3.0
      *
-     * @param array  $object Attachment object.
-     * @param string $file   File path of the attached image.
-     * @return int           Attachment ID
-     */
-    public function insert_attachment( $object, $file ) {
-        $attachment_id = wp_insert_attachment( $object, $file );
+     * @param array  $attachment An array with attachment object data.
+     * @param string $file       File path of the attached image.
+     * @return int               Attachment ID.
+     */
+    public function insert_attachment( $attachment, $file ) {
+        $attachment_id = wp_insert_attachment( $attachment, $file );
         $metadata      = wp_generate_attachment_metadata( $attachment_id, $file );