Changeset 53751 for trunk/src/wp-includes/post.php

Timestamp:

07/21/2022 06:01:01 PM (17 months ago)

Author:

adamsilverstein

Message:

Media: enable generating multiple mime types for image uploads; specifically WebP versions for JPEG images by default.

This changeset adds the capability for core media uploads to generate sub sized images in more than a single mime type. The output formats for each mime type can be controlled through a filter. WebP is used as an additional output format for JPEG images by default to improve front end performance.

When generating additional mime types, only images which are smaller than the respective original are retained. By default, additional mime type images are only generated for the built-in core image sizes and any custom sizes that have opted in.

Image meta is updated with a new 'sources' array containing file details for each mime type. Each image size in the 'sizes' array also gets a new 'sources' array that contains the image file details for each mime type.

This change also increases image upload retries to accommodate additional image sizes. It also adds a $mime_type parameter to the wp_get_missing_image_subsizes function and filter.

This change adds three new filters to enable full control of secondary mime image generation and output:

• A new filter wp_image_sizes_with_additional_mime_type_support that filters the sizes that support secondary mime type output. Developers can use this to control the output of additional mime type sub-sized images on a per size basis.
• A new filter wp_upload_image_mime_transforms that filters the output mime types for a given input mime type. Developers can use this to control generation of additional mime types for a given input mime type or even override the original mime type.
• A new filter wp_content_image_mimes which controls image mime type output selection and order for frontend content. Developers can use this to control the mime type output preference order for content images. Content images inserted from the media library will use the available image versions based on the order from this filter.

Thanks to the many contributors who helped develop, test and give feedback on this feature.

A haiku to summarize:

Upload a JPEG
Images of all sizes
Output as WebPs

Props flixos90, MatthiasReinholz, studiolxv, markhowellsmead, eatingrules, pbiron, mukesh27, joegrainger, mehulkaklotar, tweetythierry, akshitsethi, peterwilsoncc, eugenemanuilov, mitogh, shetheliving, clarkeemily, codekraft, mikeschroder, clorith, kasparsd, spacedmonkey, trevorpfromsandee, jb510, scofennellgmailcom, seedsca, cagsmith, karinclimber, dainemawer, baxbridge, grapplerulrich, sobatkras, chynnabenton, tonylocalword, barneydavey, kwillmorth, garymatthews919, olliejones, imarkinteractive, jeffpaul, feastdesignco, webbeetle, masteradhoc.

See #55443.

File:

• trunk/src/wp-includes/post.php (modified) (2 diffs)

trunk/src/wp-includes/post.php

@@ -6482 +6482 @@
 
         foreach ( $meta['sizes'] as $size => $sizeinfo ) {
-            $intermediate_file = str_replace( wp_basename( $file ), $sizeinfo['file'], $file );
-
-            if ( ! empty( $intermediate_file ) ) {
-                $intermediate_file = path_join( $uploadpath['basedir'], $intermediate_file );
-
-                if ( ! wp_delete_file_from_directory( $intermediate_file, $intermediate_dir ) ) {
-                    $deleted = false;
+
+            // Check for alternate size mime types in the sizeinfo['sources'] array to delete.
+            if ( isset( $sizeinfo['sources'] ) && is_array( $sizeinfo['sources'] ) ) {
+                foreach ( $sizeinfo['sources'] as $mime => $properties ) {
+                    $intermediate_file = str_replace( wp_basename( $file ), $properties['file'], $file );
+                    if ( ! empty( $intermediate_file ) ) {
+                        $intermediate_file = path_join( $uploadpath['basedir'], $intermediate_file );
+                        if ( ! wp_delete_file_from_directory( $intermediate_file, $intermediate_dir ) ) {
+                            $deleted = false;
+                        }
+                    }
+                }
+            } else {
+                // Otherwise, delete files from the sizeinfo data.
+                $intermediate_file = str_replace( wp_basename( $file ), $sizeinfo['file'], $file );
+
+                if ( ! empty( $intermediate_file ) ) {
+                    $intermediate_file = path_join( $uploadpath['basedir'], $intermediate_file );
+
+                    if ( ! wp_delete_file_from_directory( $intermediate_file, $intermediate_dir ) ) {
+                        $deleted = false;
+                    }
                 }
             }
@@ -6510 +6525 @@
     }
 
+    // Delete the full size images from 'sources' if available, or the root file.
+    if ( isset( $meta['sources'] ) && is_array( $meta['sources'] ) ) {
+        $sources          = $meta['sources'];
+        $intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );
+        foreach ( $sources as $mime => $properties ) {
+            if ( ! is_array( $properties ) || empty( $properties['file'] ) ) {
+                continue;
+            }
+            $intermediate_file = str_replace( wp_basename( $file ), $properties['file'], $file );
+            if ( ! wp_delete_file_from_directory( $intermediate_file, $intermediate_dir ) ) {
+                $deleted = false;
+            }
+        }
+    } else {
+        if ( ! wp_delete_file_from_directory( $file, $uploadpath['basedir'] ) ) {
+            $deleted = false;
+        }
+    }
+
     if ( is_array( $backup_sizes ) ) {
+
         $del_dir = path_join( $uploadpath['basedir'], dirname( $meta['file'] ) );
-
+        // Delete the root (edited) file which was not deleted above.
+        if ( ! wp_delete_file_from_directory( $file, $uploadpath['basedir'] ) ) {
+            $deleted = false;
+        }
         foreach ( $backup_sizes as $size ) {
-            $del_file = path_join( dirname( $meta['file'] ), $size['file'] );
-
-            if ( ! empty( $del_file ) ) {
-                $del_file = path_join( $uploadpath['basedir'], $del_file );
-
-                if ( ! wp_delete_file_from_directory( $del_file, $del_dir ) ) {
-                    $deleted = false;
+            // Delete files from 'sources' data if available, otherwise from 'sizes' data.
+            if ( isset( $meta['sources'] ) && is_array( $meta['sources'] ) ) {
+                // Delete any backup images stored in the 'sources' array.
+                if ( isset( $size['sources'] ) && is_array( $size['sources'] ) ) {
+                    foreach ( $size['sources'] as $mime => $properties ) {
+                        $del_file = path_join( dirname( $meta['file'] ), $properties['file'] );
+                        if ( ! empty( $del_file ) ) {
+                            $del_file = path_join( $uploadpath['basedir'], $del_file );
+                            if ( ! wp_delete_file_from_directory( $del_file, $del_dir ) ) {
+                                $deleted = false;
+                            }
+                        }
+                    }
+                }
+            } else {
+                $del_file = path_join( dirname( $meta['file'] ), $size['file'] );
+
+                if ( ! empty( $del_file ) ) {
+                    $del_file = path_join( $uploadpath['basedir'], $del_file );
+                    if ( ! wp_delete_file_from_directory( $del_file, $del_dir ) ) {
+                        $deleted = false;
+                    }
                 }
             }
         }
-    }
-
-    if ( ! wp_delete_file_from_directory( $file, $uploadpath['basedir'] ) ) {
-        $deleted = false;
     }