Changeset 50951

Timestamp:

05/22/2021 12:58:46 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Media: Some documentation and test improvements for the image_editor_output_format filter:

• Update the filter DocBlock per the documentation standards.
• Use a shorter variable name for consistency with the surrounding code.
• Delete the test file before performing assertions to avoid leftovers in case the test fails.

Follow-up to [50943].

See #52867.

Location:

trunk

Files:

• src/wp-includes/class-wp-image-editor.php (modified) (1 diff)
• tests/phpunit/tests/image/intermediateSize.php (modified) (4 diffs)

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

@@ -323 +323 @@
                  * the mapping array is empty, so the mime type matches the source image.
                  *
-                 * @see src/wp-includes/class-wp-image-editor.php -> get_output_format()
+                 * @see WP_Image_Editor::get_output_format()
                  *
                  * @since 5.8.0
                  *
-                 * @param array $wp_image_editor_output_format {
+                 * @param array $output_format {
                  *     An array of mime type mappings. Maps a source mime type to a new
-                 *     destination mime type. Empty by default.
+                 *     destination mime type. Default empty array.
                  *
                  *     @type array $mime_type The source mime type {
                  *         @type string $mime_type The new mime type.
                  *     }
-                 * @param string $filename Path to the image.
+                 * @param string $filename  Path to the image.
                  * @param string $mime_type The source image mime type.
                  * }
                  */
-                $wp_image_editor_output_format = apply_filters( 'image_editor_output_format', array(), $filename, $mime_type );
-
-                if (
-                        isset( $wp_image_editor_output_format[ $mime_type ] ) &&
-                        $this->supports_mime_type( $wp_image_editor_output_format[ $mime_type ] )
+                $output_format = apply_filters( 'image_editor_output_format', array(), $filename, $mime_type );
+
+                if ( isset( $output_format[ $mime_type ] )
+                        && $this->supports_mime_type( $output_format[ $mime_type ] )
                 ) {
-                        $mime_type = $wp_image_editor_output_format[ $mime_type ];
-                        $new_ext = $this->get_extension( $mime_type );
+                        $mime_type = $output_format[ $mime_type ];
+                        $new_ext   = $this->get_extension( $mime_type );
                 }
 

trunk/tests/phpunit/tests/image/intermediateSize.php

@@ -53 +53 @@
                 $image = image_make_intermediate_size( DIR_TESTDATA . '/images/a2-small.jpg', 100, 75, true );
 
+                unlink( DIR_TESTDATA . '/images/a2-small-100x75.jpg' );
+
                 $this->assertInternalType( 'array', $image );
                 $this->assertSame( 100, $image['width'] );
@@ -59 +61 @@
 
                 $this->assertFalse( isset( $image['path'] ) );
-
-                unlink( DIR_TESTDATA . '/images/a2-small-100x75.jpg' );
-        }
-
-        /**
-         * @requires function imagejpeg
+        }
+
+        /**
          * @ticket 52867
+         * @requires function imagejpeg
          */
         function test_image_editor_output_format_filter() {
@@ -74 +74 @@
                         }
                 );
+
                 $file   = DIR_TESTDATA . '/images/waffles.jpg';
                 $image  = image_make_intermediate_size( $file, 100, 75, true );
                 $editor = wp_get_image_editor( $file );
+
+                unlink( DIR_TESTDATA . '/images/' . $image['file'] );
+                remove_all_filters( 'image_editor_output_format' );
+
                 if ( is_wp_error( $editor ) || ! $editor->supports_mime_type( 'image/webp' ) ) {
                         $this->assertSame( 'image/jpeg', $image['mime-type'] );
@@ -82 +87 @@
                         $this->assertSame( 'image/webp', $image['mime-type'] );
                 }
-                unlink( DIR_TESTDATA . '/images/' . $image['file'] );
-                remove_all_filters( 'image_editor_output_format' );
         }