Changeset 51790

Timestamp:

09/09/2021 08:38:20 PM (5 years ago)

Author:

hellofromTonya

Message:

Code Modernization: Fix parameter name mismatches for parent/child classes in WP_Image_Editor::save().

Renames the first parameter in WP_Image_Editor_GD::save() to match the parent's method signature.
Why? PHP 8 introduces the ability to pass named arguments to function/method calls. This means the child and parent method signatures (i.e. parameter names) need to match.

Adds @since to clearly specify why the change happened.

Adds parameter descriptions to parent and both child classes.

Follow-up to [22094], [22619], [30681].

Props jrf, hellofromTonya, sergeybiryukov, azaozz, desrosj, johnbillion.
See #51553.

Location:

trunk/src/wp-includes

Files:

• class-wp-image-editor-gd.php (modified) (1 diff)
• class-wp-image-editor-imagick.php (modified) (1 diff)
• class-wp-image-editor.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-image-editor-gd.php

@@ -424 +424 @@
          *
          * @since 3.5.0
-         *
-         * @param string|null $filename
-         * @param string|null $mime_type
+         * @since 5.9.0 Renamed `$filename` to `$destfilename` to match parent class
+         *              for PHP 8 named parameter support.
+         *
+         * @param string|null $destfilename Optional. Destination filename. Default null.
+         * @param string|null $mime_type    Optional. The mime-type. Default null.
          * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
          */
-        public function save( $filename = null, $mime_type = null ) {
-                $saved = $this->_save( $this->image, $filename, $mime_type );
+        public function save( $destfilename = null, $mime_type = null ) {
+                $saved = $this->_save( $this->image, $destfilename, $mime_type );
 
                 if ( ! is_wp_error( $saved ) ) {

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -663 +663 @@
          * @since 3.5.0
          *
-         * @param string $destfilename
-         * @param string $mime_type
+         * @param string $destfilename Optional. Destination filename. Default null.
+         * @param string $mime_type    Optional. The mime-type. Default null.
          * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
          */

trunk/src/wp-includes/class-wp-image-editor.php

@@ -78 +78 @@
          * @abstract
          *
-         * @param string $destfilename
-         * @param string $mime_type
+         * @param string $destfilename Optional. Destination filename. Default null.
+         * @param string $mime_type    Optional. The mime-type. Default null.
          * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
          */