Changeset 59473 for trunk/src/wp-includes/class-wp-image-editor.php

Timestamp:

11/29/2024 11:46:50 PM (5 months ago)

Author:

adamsilverstein

Message:

Media: improve filter to enable setting output quality by image size.

Add a new $size parameter to the wp_editor_set_quality filter. $size is an array with 'width' and 'height' keys. Developers can use this information to set image quality based on the image size.

Props adamsilverstein, joemcgill, Mte90, codekraft, birgire, azaozz, sppramodh.
Fixes #54648.

File:

• trunk/src/wp-includes/class-wp-image-editor.php (modified) (2 diffs)

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

@@ -241 +241 @@
      *
      * @since 3.5.0
-     *
-     * @param int $quality Compression Quality. Range: [1,100]
+     * @since 6.8.0 The `$dims` parameter was added.
+     *
+     * @param int   $quality Compression Quality. Range: [1,100]
+     * @param array $dims    Optional. Image dimensions array with 'width' and 'height' keys.
      * @return true|WP_Error True if set successfully; WP_Error on failure.
-     */
-    public function set_quality( $quality = null ) {
+
+     */
+    public function set_quality( $quality = null, $dims = array() ) {
         // Use the output mime type if present. If not, fall back to the input/initial mime type.
         $mime_type = ! empty( $this->output_mime_type ) ? $this->output_mime_type : $this->mime_type;
@@ -261 +264 @@
              *
              * @since 3.5.0
+             * @since 6.8.0 Added the size parameter.
              *
              * @param int    $quality   Quality level between 1 (low) and 100 (high).
              * @param string $mime_type Image mime type.
+             * @param array $size {
+             *     Dimensions of the image.
+             *
+             *     @type int $width  The image width.
+             *     @type int $height The image height.
+             * }
              */
-            $quality = apply_filters( 'wp_editor_set_quality', $default_quality, $mime_type );
+            $quality = apply_filters( 'wp_editor_set_quality', $default_quality, $mime_type, $dims ? $dims : $this->size );
 
             if ( 'image/jpeg' === $mime_type ) {