<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[28879] trunk: Add `->get_quality()` method to `WP_Image_Editor` class.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/28879">28879</a></dd>
<dt>Author</dt> <dd>wonderboymusic</dd>
<dt>Date</dt> <dd>2014-06-28 03:49:55 +0000 (Sat, 28 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add `->get_quality()` method to `WP_Image_Editor` class.
Adds unit tests.
Props markoheijnen.
Fixes <a href="http://core.trac.wordpress.org/ticket/28154">#28154</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpimageeditorgdphp">trunk/src/wp-includes/class-wp-image-editor-gd.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorimagickphp">trunk/src/wp-includes/class-wp-image-editor-imagick.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorphp">trunk/src/wp-includes/class-wp-image-editor.php</a></li>
<li><a href="#trunktestsphpunittestsimageeditorphp">trunk/tests/phpunit/tests/image/editor.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpimageeditorgdphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-image-editor-gd.php (28878 => 28879)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-image-editor-gd.php 2014-06-28 03:29:10 UTC (rev 28878)
+++ trunk/src/wp-includes/class-wp-image-editor-gd.php 2014-06-28 03:49:55 UTC (rev 28879)
</span><span class="lines">@@ -114,7 +114,7 @@
</span><span class="cx"> $this->update_size( $size[0], $size[1] );
</span><span class="cx"> $this->mime_type = $size['mime'];
</span><span class="cx">
</span><del>- return $this->set_quality( $this->quality );
</del><ins>+ return true;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -394,7 +394,7 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx"> elseif ( 'image/jpeg' == $mime_type ) {
</span><del>- if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->quality ) ) )
</del><ins>+ if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->get_quality() ) ) )
</ins><span class="cx"> return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
</span><span class="cx"> }
</span><span class="cx"> else {
</span><span class="lines">@@ -442,7 +442,7 @@
</span><span class="cx"> return imagegif( $this->image );
</span><span class="cx"> default:
</span><span class="cx"> header( 'Content-Type: image/jpeg' );
</span><del>- return imagejpeg( $this->image, null, $this->quality );
</del><ins>+ return imagejpeg( $this->image, null, $this->get_quality() );
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorimagickphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-image-editor-imagick.php (28878 => 28879)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-image-editor-imagick.php 2014-06-28 03:29:10 UTC (rev 28878)
+++ trunk/src/wp-includes/class-wp-image-editor-imagick.php 2014-06-28 03:49:55 UTC (rev 28879)
</span><span class="lines">@@ -143,7 +143,7 @@
</span><span class="cx"> if ( is_wp_error( $updated_size ) )
</span><span class="cx"> return $updated_size;
</span><span class="cx">
</span><del>- return $this->set_quality( $this->quality );
</del><ins>+ return true;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -160,7 +160,7 @@
</span><span class="cx"> if ( is_wp_error( $quality_result ) ) {
</span><span class="cx"> return $quality_result;
</span><span class="cx"> } else {
</span><del>- $quality = $this->quality;
</del><ins>+ $quality = $this->get_quality();
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> try {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/class-wp-image-editor.php (28878 => 28879)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/class-wp-image-editor.php 2014-06-28 03:29:10 UTC (rev 28878)
+++ trunk/src/wp-includes/class-wp-image-editor.php 2014-06-28 03:49:55 UTC (rev 28879)
</span><span class="lines">@@ -16,7 +16,8 @@
</span><span class="cx"> protected $size = null;
</span><span class="cx"> protected $mime_type = null;
</span><span class="cx"> protected $default_mime_type = 'image/jpeg';
</span><del>- protected $quality = 90;
</del><ins>+ protected $quality = false;
+ protected $default_quality = 90;
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Each instance handles a single file.
</span><span class="lines">@@ -203,50 +204,64 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets Image Compression quality on a 1-100% scale.
</del><ins>+ * Gets the Image Compression quality on a 1-100% scale.
</ins><span class="cx"> *
</span><del>- * @since 3.5.0
</del><ins>+ * @since 4.0.0
</ins><span class="cx"> * @access public
</span><span class="cx"> *
</span><del>- * @param int $quality Compression Quality. Range: [1,100]
- * @return boolean|WP_Error True if set successfully; WP_Error on failure.
</del><ins>+ * @return int $quality Compression Quality. Range: [1,100]
</ins><span class="cx"> */
</span><del>- public function set_quality( $quality = null ) {
- if ( $quality == null ) {
- $quality = $this->quality;
- }
-
- /**
- * Filter the default image compression quality setting.
- *
- * @since 3.5.0
- *
- * @param int $quality Quality level between 1 (low) and 100 (high).
- * @param string $mime_type Image mime type.
- */
- $quality = apply_filters( 'wp_editor_set_quality', $quality, $this->mime_type );
-
- if ( 'image/jpeg' == $this->mime_type ) {
</del><ins>+ public function get_quality() {
+ if ( ! $this->quality ) {
</ins><span class="cx"> /**
</span><del>- * Filter the JPEG compression quality for backward-compatibility.
</del><ins>+ * Filter the default image compression quality setting.
</ins><span class="cx"> *
</span><del>- * The filter is evaluated under two contexts: 'image_resize', and 'edit_image',
- * (when a JPEG image is saved to file).
</del><ins>+ * @since 3.5.0
</ins><span class="cx"> *
</span><del>- * @since 2.5.0
- *
- * @param int $quality Quality level between 0 (low) and 100 (high) of the JPEG.
- * @param string $context Context of the filter.
</del><ins>+ * @param int $quality Quality level between 1 (low) and 100 (high).
+ * @param string $mime_type Image mime type.
</ins><span class="cx"> */
</span><del>- $quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
</del><ins>+ $quality = apply_filters( 'wp_editor_set_quality', $this->default_quality, $this->mime_type );
</ins><span class="cx">
</span><del>- // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
- if ( $quality == 0 ) {
- $quality = 1;
</del><ins>+ if ( 'image/jpeg' == $this->mime_type ) {
+ /**
+ * Filter the JPEG compression quality for backward-compatibility.
+ *
+ * The filter is evaluated under two contexts: 'image_resize', and 'edit_image',
+ * (when a JPEG image is saved to file).
+ *
+ * @since 2.5.0
+ *
+ * @param int $quality Quality level between 0 (low) and 100 (high) of the JPEG.
+ * @param string $context Context of the filter.
+ */
+ $quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
+
+ if ( ! $this->set_quality( $quality ) ) {
+ $this->quality = $this->default_quality;
+ }
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( ( $quality >= 1 ) && ( $quality <= 100 ) ){
</del><ins>+ return $this->quality;
+ }
+
+ /**
+ * Sets Image Compression quality on a 1-100% scale.
+ *
+ * @since 3.5.0
+ * @access public
+ *
+ * @param int $quality Compression Quality. Range: [1,100]
+ * @return boolean|WP_Error True if set successfully; WP_Error on failure.
+ */
+ public function set_quality( $quality = null ) {
+ // 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 ) ) {
</ins><span class="cx"> $this->quality = $quality;
</span><span class="cx"> return true;
</span><span class="cx"> } else {
</span></span></pre></div>
<a id="trunktestsphpunittestsimageeditorphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/image/editor.php (28878 => 28879)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/image/editor.php 2014-06-28 03:29:10 UTC (rev 28878)
+++ trunk/tests/phpunit/tests/image/editor.php 2014-06-28 03:49:55 UTC (rev 28879)
</span><span class="lines">@@ -52,19 +52,15 @@
</span><span class="cx"> // Get an editor
</span><span class="cx"> $editor = wp_get_image_editor( DIR_TESTDATA . '/images/canola.jpg' );
</span><span class="cx">
</span><del>- // Make quality readable
- $property = new ReflectionProperty( $editor, 'quality' );
- $property->setAccessible( true );
-
</del><span class="cx"> // Ensure set_quality works
</span><span class="cx"> $this->assertTrue( $editor->set_quality( 75 ) );
</span><del>- $this->assertEquals( 75, $property->getValue( $editor ) );
</del><ins>+ $this->assertEquals( 75, $editor->get_quality() );
</ins><span class="cx">
</span><span class="cx"> // Ensure the quality filter works
</span><span class="cx"> $func = create_function( '', "return 100;");
</span><span class="cx"> add_filter( 'wp_editor_set_quality', $func );
</span><span class="cx"> $this->assertTrue( $editor->set_quality( 75 ) );
</span><del>- $this->assertEquals( 100, $property->getValue( $editor ) );
</del><ins>+ $this->assertEquals( 75, $editor->get_quality() );
</ins><span class="cx">
</span><span class="cx"> // Clean up
</span><span class="cx"> remove_filter( 'wp_editor_set_quality', $func );
</span></span></pre>
</div>
</div>
</body>
</html>