Ensure post meta reflects image mime type

[adamsilverstein]

When uploading jpeg images with the webp-uploads module, we use WebP as the default file type for sub sized images. The post meta that lists the image sizes includes a mime-type value; we should ensure that matches the sub sized image mime type.

As reported in #32 (comment)

[mitogh]

Related with

• Image is partially converted to WebP #69
• Image mime type is not set correctly when a webp image is generated. #67

[erikyo]

hi @adamsilverstein,
This is an experiment, I did would try to solve these two issues (the other one is the #122), but after all I guess this definitively isn't in a great way because it adds an additional filter in order to work. Maybe it would be better to add a filter to media_handle_upload (wp-admin/includes/media.php) because without this, I can be wrong but as far as I know, the uploaded image cannot be touched before this hook.

I also don't understand why after this filter the "cloned" webp isn't deleted when I delete the image from WordPress media library, even if the attachment metadata array seems correct. I suspect this issue is related to wp_unique_filename() but not sure.

https://gist.github.com/erikyo/f0aca6c34fd1d6bc5f73f953bb342a65
(needs to be used alongside Module WebP Uploads)

[adamsilverstein]

I also don't understand why after this filter the "cloned" webp isn't deleted when I delete the image from WordPress media library, even if the attachment metadata array seems correct. I suspect this issue is related to wp_unique_filename() but not sure.

I think you need to add the new file data to the returned new_sizes? if you look at the meta data after uploading, does it reference both the jpeg and webp images, or just jpeg? or is your idea to add the webp type on the fly?

[erikyo]

yes, my idea is to replace also the "full" size image on the fly with the copy in webp format (so replacing the $meta['file']), since the original jpg was already stored (or can be stored) as "original_image" and since I don't want to show jpg images when I wp_get_attachment_image().

At the time the filter is fired, the image has already been saved (but the resizes are not and the sizes array is empty), my idea is to use this filter to hack the image_meta before the subsizes image were generated. This to avoid #69 because sometimes (eg. small images without the -scaled) the image meta are like below:

Array
(
    [width] => 945
    [height] => 1007
    [file] => 2022/01/small-image.jpeg
    [sizes] => Array
    (...)

    [image_meta] => Array
    (...)
)

this is the reason why i add this in my filter

$image_meta['file'] = $webp_file;
wp_update_attachment_metadata( $attachment_id, $image_meta );

And in addition i replace the "post_mime_type" of this post to ensure post type attachment meta reflects image mime type (see here). Change the post mime was a bad idea #67 (comment)

wp_update_post( array(
  'ID'             => $attachment_id,
  'post_mime_type' => 'image/webp'
) );

After my filter the image_metadata will look like this:

Array
(
    [width] => 945
    [height] => 1007
++  [file] => 2022/01/vert.webp
--  [file] => 2022/01/vert.jpg

But after the sub-sizes have been generated it appears that full is a jpg and not a webp. I didn't realise that (and this is the reason why the full webp image wasn't deleted), I'll try to find out why.

Array
(
    [width] => 945
    [height] => 1007
    [file] => 2022/01/vert.jpeg
    [sizes] => Array
        (
            [medium] => Array
                (
                    [file] => vert-441x470.webp
                    [width] => 441
                    [height] => 470
                    [mime-type] => image/webp
                )

            [thumbnail] => Array
                (
                    [file] => vert-150x150.webp
                    [width] => 150
                    [height] => 150
                    [mime-type] => image/webp
                )

            [medium_large] => Array
                (
                    [file] => vert-768x818.webp
                    [width] => 768
                    [height] => 818
                    [mime-type] => image/webp
                )

            [post-thumbnail] => Array
                (
                    [file] => vert-400x426.webp
                    [width] => 400
                    [height] => 426
                    [mime-type] => image/webp
                )

        )

    [image_meta] => Array
        (...)
)

edit: the reason why my filter was overridden was because _wp_make_subsizes() saves again the image metadata using the argument $image_meta which comes as it is generated here so doing it so early is not good.

Besides this, I discovered a way that is perhaps better for updating the meta of small images:

if (!isset($image_meta['original_image'])) {
    // replace the original image path with the webp image path
    $image_meta['original_image'] = $image_meta['file'];
    $image_meta['file'] = $webp_file;
    wp_update_attachment_metadata( $attachment_id, $image_meta );
}

[erikyo]

Moving the filter after the image subsizes generation (using wp_generate_attachment_metadata) has fixed the issue and the generated image full size image was deleted but the old "original_image" not 😥. Again, an additional filter (like 'delete_attachment') would be needed to delete the original_image because it does not happen automatically as I expected.

The image_meta array actually looks is like this:

Array
(
    [width] => 945
    [height] => 1007
    [file] => 2022/02/vertical_img-1.webp
    [sizes] => Array
        (
            [medium] => Array
                (
                    [file] => vertical_img-1-441x470.webp
                    [width] => 441
                    [height] => 470
                    [mime-type] => image/webp
                )

            [thumbnail] => Array
                (
                    [file] => vertical_img-1-150x150.webp
                    [width] => 150
                    [height] => 150
                    [mime-type] => image/webp
                )

            [medium_large] => Array
                (
                    [file] => vertical_img-1-768x818.webp
                    [width] => 768
                    [height] => 818
                    [mime-type] => image/webp
                )

            [post-thumbnail] => Array
                (
                    [file] => vertical_img-1-400x426.webp
                    [width] => 400
                    [height] => 426
                    [mime-type] => image/webp
                )

        )

    [image_meta] => Array
        (
            [aperture] => 0
            [credit] => 
            [camera] => 
            [caption] => 
            [created_timestamp] => 0
            [copyright] => 
            [focal_length] => 0
            [iso] => 0
            [shutter_speed] => 0
            [title] => 
            [orientation] => 0
            [keywords] => Array
                (
                )

        )

    [original_image] => 2022/02/vertical_img-1.jpeg
)

[erikyo]

the original_image would have been deleted if I had written the path correctly.

updated the gist now the filter it work as expected (or at least it does in the way I would like it work).
https://gist.github.com/erikyo/f0aca6c34fd1d6bc5f73f953bb342a65

Honestly, I would like the original jpg to be used only when I have to regenerate images, when I have to serve it to users I would prefer it to be always webp.

[adamsilverstein]

Honestly, I would like the original jpg to be used only when I have to regenerate images, when I have to serve it to users I would prefer it to be always webp.

If you have the right srcset, this should be the case, even if the image src says jpeg, the browser will load the correct webp from the srcset list. I tested mostly with twentytwentytwo, the behavior may be theme dependent

[erikyo]

I created a test for this case:
https://codepen.io/erikyo/pen/Rwjaoqa
https://modul-r.codekraft.it/2022/02/image-test/

Currently, what I've noticed is that chrome uses the image in src if it fits perfectly in its container or if the images is smaller than that, and this happens also if there is a webp image of the same size of the original in srcset. I'm using canary which is chrome 3 versions ahead and i don't think that will change anytime soon. Tested also in FF, Edge and safari seem to have the same behaviour (in this case, with my blog).

https://html.spec.whatwg.org/multipage/images.html#image-request
https://html.spec.whatwg.org/multipage/images.html#images-processing-model