Changeset 53751 for trunk/src/wp-includes/class-wp-image-editor.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/class-wp-image-editor.php (modified) (4 diffs)

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

@@ -334 +334 @@
     protected function get_output_format( $filename = null, $mime_type = null ) {
         $new_ext = null;
+
+        // If no mime type is passed but output mime type is set, use that.
+        if ( ! $mime_type && ! empty( $this->output_mime_type ) ) {
+            $mime_type = $this->output_mime_type;
+        }
 
         // By default, assume specified type takes priority.
@@ -426 +431 @@
 
     /**
-     * Builds an output filename based on current file, and adding proper suffix
-     *
-     * @since 3.5.0
-     *
-     * @param string $suffix
-     * @param string $dest_path
-     * @param string $extension
-     * @return string filename
+     * Builds an output filename based on current file, and adding proper suffix.
+     *
+     * @since 3.5.0
+     * @since 6.1.0 Skips adding a suffix when set to an empty string. When the
+     *              file extension being generated doesn't match the image file extension,
+     *              add the extension to the suffix
+     *
+     * @param string $suffix    Optional. Suffix to add to the filename. The default null
+     *                          will result in a 'widthxheight' suffix. Passing
+     *                          an empty string will result in no suffix.
+     * @param string $dest_path Optional. The path to save the file to. The default null
+     *                          will use the image file path.
+     * @param string $extension Optional. The file extension to use. The default null
+     *                          will use the image file extension.
+     * @return string filename The generated file name.
      */
     public function generate_filename( $suffix = null, $dest_path = null, $extension = null ) {
         // $suffix will be appended to the destination filename, just before the extension.
-        if ( ! $suffix ) {
+        if ( null === $suffix ) {
             $suffix = $this->get_suffix();
         }
@@ -458 +470 @@
         }
 
-        return trailingslashit( $dir ) . "{$name}-{$suffix}.{$new_ext}";
+        if ( empty( $suffix ) ) {
+            $suffix = '';
+        } else {
+            $suffix = "-{$suffix}";
+        }
+
+        // When the file extension being generated doesn't match the image file extension,
+        // add the extension to the suffix to ensure a unique file name. Prevents
+        // name conflicts when a single image type can have multiple extensions,
+        // eg. .jpg, .jpeg and .jpe are all valid JPEG extensions.
+        if ( ! empty( $extension ) && $extension !== $ext ) {
+            $suffix .= "-{$ext}";
+        }
+
+        return trailingslashit( $dir ) . "{$name}{$suffix}.{$new_ext}";
     }
 
@@ -638 +664 @@
         return wp_get_default_extension_for_mime_type( $mime_type );
     }
+
+    /**
+     * Set the editor output mime type, useful when outputting alternate mime types.
+     *
+     * Track that the mime type is set with the mime type set flag.
+     *
+     * @since 6.1.0
+     *
+     * @param string $output_mime_type The mime type to set.
+     */
+    public function set_output_mime_type( $output_mime_type ) {
+        $this->output_mime_type = $output_mime_type;
+    }
+
+    /**
+     * Reset the mime type to the original file mime type.
+     *
+     * Reset the mime type set flag.
+     *
+     * @since 6.1.0
+     */
+    public function reset_output_mime_type() {
+        $this->output_mime_type = $this->mime_type;
+    }
 }
-