Changeset 51444

Timestamp:

07/15/2021 09:09:33 PM (3 years ago)

Author:

desrosj

Message:

Media: Document edge cases with the new image_editor_output_format filter.

More testing has revealed that the image_editor_output_format filter has some interesting edge cases that developers should be aware of when electing to use this filter (see #53667 and #53668).

Because this is a new filter that was intended to be used for experimenting with different ways to handle generating image sizes and has not yet been adopted in the wild, expanding the inline documentation is an acceptable temporary solution while these edge cases are explored further and addressed.

Props mikeschroder, antpb, desrosj, adamsilverstein, ianmjones.
Merges [51442] to the 5.8 branch.
See #53667, #53668, #35725.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-image-editor.php (modified) (1 diff)

branches/5.8/src/wp-includes/class-wp-image-editor.php

@@ -323 +323 @@
          * the mapping array is empty, so the mime type matches the source image.
          *
+         * This should be considered experimental as there are a few edge cases that
+         * still need to be solved.
+         *
+         * When this filter is used in combination with the {@see 'wp_editor_set_quality'}
+         * filter, the image quality value used will be that of the original mime type,
+         * not the mapped one. This could result in unexpected image quality for generated
+         * images. See https://core.trac.wordpress.org/ticket/53667 for more details.
+         *
+         * When a mime type is mapped to another, and two images with the same name are
+         * uploaded (image.jpg and image.webp, for example), the generated images for one
+         * will potentially overwrite the other's.
+         * See https://core.trac.wordpress.org/ticket/53668 for more details.
+         *
          * @see WP_Image_Editor::get_output_format()
          *