vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Media: Document edge cases with the new image_editor_output_format filter.

Browse Source 
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.
See #5366, #53668, #35725.

git-svn-id: https://develop.svn.wordpress.org/trunk@51442 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jonathan Desrosiers 2021-07-15 17:38:57 +00:00
parent 41ba4acb83
commit 025e59a1ef
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/wp-includes/class-wp-image-editor.php
View File

@ -322,6 +322,19 @@ abstract class WP_Image_Editor {
* Enables filtering the mime type used to save images. By default,
* 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()
*
* @since 5.8.0