Changeset 26645

Timestamp:

12/04/2013 10:48:45 PM (11 years ago)

Author:

nacin

Message:

Improvements to image quality handling in the image editor classes.

props markoheijnen, DH-Shredder.
fixes #25721.

Location:

trunk/src/wp-includes

Files:

• class-wp-image-editor-gd.php (modified) (5 diffs)
• class-wp-image-editor-imagick.php (modified) (5 diffs)
• class-wp-image-editor.php (modified) (2 diffs)

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

@@ -78 +78 @@
      * @access protected
      *
-     * @return boolean|\WP_Error
+     * @return boolean|WP_Error True if loaded successfully; WP_Error on failure.
      */
     public function load() {
@@ -87 +87 @@
             return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
 
+        /**
+         * Filter the memory limit allocated for image manipulation.
+         *
+         * @since 3.5.0
+         *
+         * @param int Maximum memory limit to allocate (default is WP_MAX_MEMORY_LIMIT)
+         */
         // Set artificially high because GD uses uncompressed images in memory
         @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
+
         $this->image = @imagecreatefromstring( file_get_contents( $this->file ) );
 
@@ -106 +114 @@
         $this->mime_type = $size['mime'];
 
-        return true;
+        return $this->set_quality( $this->quality );
     }
 
@@ -362 +370 @@
         }
         elseif ( 'image/jpeg' == $mime_type ) {
-            if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, apply_filters( 'jpeg_quality', $this->quality, 'image_resize' ) ) ) )
+            if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->quality ) ) ) 
                 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
         }
@@ -374 +382 @@
         @ chmod( $filename, $perms );
 
+        /**
+         * Filter the name of the saved image file.
+         *
+         * @since 2.6.0
+         *
+         * @param string $filename Name of the file.
+         */
         return array(
-            'path' => $filename,
-            'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
-            'width' => $this->size['width'],
-            'height' => $this->size['height'],
-            'mime-type'=> $mime_type,
+            'path'      => $filename,
+            'file'      => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
+            'width'     => $this->size['width'],
+            'height'    => $this->size['height'],
+            'mime-type' => $mime_type,
         );
     }

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

@@ -120 +120 @@
             return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
 
+        /** This filter is documented in wp-includes/class-wp-image-editor-imagick.php */ 
         // Even though Imagick uses less PHP memory than GD, set higher limit for users that have low PHP.ini limits
         @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
@@ -143 +144 @@
                 return $updated_size;
 
-        return $this->set_quality();
+        return $this->set_quality( $this->quality );
     }
 
@@ -153 +154 @@
      *
      * @param int $quality Compression Quality. Range: [1,100]
-     * @return boolean|WP_Error
+     * @return boolean|WP_Error True if set successfully; WP_Error on failure.
      */
     public function set_quality( $quality = null ) {
-        if ( !$quality )
+        $quality_result = parent::set_quality( $quality );
+        if ( is_wp_error( $quality_result ) ) {
+            return $quality_result;
+        } else {
             $quality = $this->quality;
-
-        try {
-            if( 'image/jpeg' == $this->mime_type ) {
-                $this->image->setImageCompressionQuality( apply_filters( 'jpeg_quality', $quality, 'image_resize' ) );
+        }
+
+        try {
+            if ( 'image/jpeg' == $this->mime_type ) {
+                $this->image->setImageCompressionQuality( $quality );
                 $this->image->setImageCompression( imagick::COMPRESSION_JPEG );
             }
@@ -172 +177 @@
         }
 
-        return parent::set_quality( $quality );
+        return true;
     }
 
@@ -448 +453 @@
         @ chmod( $filename, $perms );
 
+        /** This filter is documented in wp-includes/class-wp-image-editor-gd.php */ 
         return array(
-            'path' => $filename,
-            'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
-            'width' => $this->size['width'],
-            'height' => $this->size['height'],
+            'path'      => $filename,
+            'file'      => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
+            'width'     => $this->size['width'],
+            'height'    => $this->size['height'],
             'mime-type' => $mime_type,
         );

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

@@ -206 +206 @@
      *
      * @param int $quality Compression Quality. Range: [1,100]
-     * @return boolean
-     */
-    public function set_quality( $quality ) {
+     * @return boolean|WP_Error True if set successfully; WP_Error on failure.
+     */
+    public function set_quality( $quality = null ) {
+        if ( $quality == null ) {
+            $quality = $this->quality;
+        }
+
         /**
          * Filter the default quality setting.
@@ -214 +218 @@
          * @since 3.5.0
          *
-         * @param int $quality Quality level between 0 (low) and 100 (high).
+         * @param int $quality Quality level between 1 (low) and 100 (high).
          */
-        $this->quality = apply_filters( 'wp_editor_set_quality', $quality );
-
-        return ( (bool) $this->quality );
+        $quality = apply_filters( 'wp_editor_set_quality', $quality, $this->mime_type );
+
+        /**
+         * Filter the JPEG quality for backwards compatibilty.
+         *
+         * @since 2.5.0
+         *
+         * @param int $quality Quality level between 0 (low) and 100 (high) of the JPEG.
+         * @param string The context of the filter.
+         */
+        if ( 'image/jpeg' == $this->mime_type ) {
+            $quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
+
+            // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
+            if ( $quality == 0 ) {
+                $quality = 1;
+            }
+        }
+
+        if ( ( $quality >= 1 ) && ( $quality <= 100 ) ){
+            $this->quality = $quality;
+            return true;
+        } else {
+            return new WP_Error( 'invalid_image_quality', __('Attempted to set image quality outside of the range [1,100].') );
+        }
     }