<!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>[51712] branches/5.8/tests/phpunit: Media: apply the `wp_editor_set_quality` filter not only when loading an image in the editor but also when saving an converted image, after the mime-type of the output image has changed.</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 { white-space: pre-line; 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/51712">51712</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/51712","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-09-01 00:43:39 +0000 (Wed, 01 Sep 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Media: apply the `wp_editor_set_quality` filter not only when loading an image in the editor but also when saving an converted image, after the mime-type of the output image has changed.
Props mikeschroder, desrosj, azaozz.
Merges <a href="https://core.trac.wordpress.org/changeset/51704">[51704]</a> to the 5.8 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/53667">#53667</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches58srcwpincludesclasswpimageeditorphp">branches/5.8/src/wp-includes/class-wp-image-editor.php</a></li>
<li><a href="#branches58testsphpunitincludesmockimageeditorphp">branches/5.8/tests/phpunit/includes/mock-image-editor.php</a></li>
<li><a href="#branches58testsphpunittestsimageeditorphp">branches/5.8/tests/phpunit/tests/image/editor.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches58">branches/5.8/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/5.8
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/5.8 2021-09-01 00:33:28 UTC (rev 51711)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/5.8 2021-09-01 00:43:39 UTC (rev 51712)
</ins><a id="branches58"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/5.8</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:51274,51277,51279-51284,51286-51289,51292-51294,51296,51304,51307,51309,51321-51324,51332,51343-51344,51348-51349,51351-51353,51355-51356,51359,51362,51369-51371,51375,51377,51380,51383,51387-51388,51390,51400,51402,51408-51410,51413-51414,51418,51421,51423,51426,51431-51432,51435,51440,51442-51443,51455,51459,51467-51469,51471-51474,51482-51483,51485-51486,51497-51498,51510,51525,51538-51540,51595,51611,51631-51632,51637,51649,51653,51673-51674,51682-51683,51686,51688-51689,51693,51700-51701,51703
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:51274,51277,51279-51284,51286-51289,51292-51294,51296,51304,51307,51309,51321-51324,51332,51343-51344,51348-51349,51351-51353,51355-51356,51359,51362,51369-51371,51375,51377,51380,51383,51387-51388,51390,51400,51402,51408-51410,51413-51414,51418,51421,51423,51426,51431-51432,51435,51440,51442-51443,51455,51459,51467-51469,51471-51474,51482-51483,51485-51486,51497-51498,51510,51525,51538-51540,51595,51611,51631-51632,51637,51649,51653,51673-51674,51682-51683,51686,51688-51689,51693,51700-51701,51703-51704
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches58srcwpincludesclasswpimageeditorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.8/src/wp-includes/class-wp-image-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.8/src/wp-includes/class-wp-image-editor.php 2021-09-01 00:33:28 UTC (rev 51711)
+++ branches/5.8/src/wp-includes/class-wp-image-editor.php 2021-09-01 00:43:39 UTC (rev 51712)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,10 +15,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $file = null;
</span><span class="cx" style="display: block; padding: 0 10px"> protected $size = null;
</span><span class="cx" style="display: block; padding: 0 10px"> protected $mime_type = null;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $output_mime_type = null;
</ins><span class="cx" style="display: block; padding: 0 10px"> protected $default_mime_type = 'image/jpeg';
</span><span class="cx" style="display: block; padding: 0 10px"> protected $quality = false;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected $default_quality = 82;
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Deprecated since 5.8.1. See get_default_quality() below.
+ protected $default_quality = 82;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Each instance handles a single file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,6 +227,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return true|WP_Error True if set successfully; WP_Error on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function set_quality( $quality = null ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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;
+ // Get the default quality setting for the mime type.
+ $default_quality = $this->get_default_quality( $mime_type );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( null === $quality ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the default image compression quality setting.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -238,9 +246,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $quality Quality level between 1 (low) and 100 (high).
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $mime_type Image mime type.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $quality = apply_filters( 'wp_editor_set_quality', $this->default_quality, $this->mime_type );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $quality = apply_filters( 'wp_editor_set_quality', $default_quality, $mime_type );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'image/jpeg' === $this->mime_type ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'image/jpeg' === $mime_type ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the JPEG compression quality for backward-compatibility.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,7 +269,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $quality < 0 || $quality > 100 ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $quality = $this->default_quality;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $quality = $default_quality;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -279,6 +287,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns the default compression quality setting for the mime type.
+ *
+ * @since 5.8.1
+ *
+ * @param string $mime_type
+ * @return int The default quality setting for the mime type.
+ */
+ protected function get_default_quality( $mime_type ) {
+ switch ( $mime_type ) {
+ case 'image/webp':
+ $quality = 86;
+ break;
+ case 'image/jpeg':
+ default:
+ $quality = $this->default_quality;
+ }
+
+ return $quality;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Returns preferred mime-type and extension based on provided
</span><span class="cx" style="display: block; padding: 0 10px"> * file's extension and mime, or current file's extension and mime.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -374,7 +403,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $new_ext = $this->get_extension( $mime_type );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $filename ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ensure both $filename and $new_ext are not empty.
+ // $this->get_extension() returns false on error which would effectively remove the extension
+ // from $filename. That shouldn't happen, files without extensions are not supported.
+ if ( $filename && $new_ext ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $dir = pathinfo( $filename, PATHINFO_DIRNAME );
</span><span class="cx" style="display: block; padding: 0 10px"> $ext = pathinfo( $filename, PATHINFO_EXTENSION );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -381,6 +413,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $filename = trailingslashit( $dir ) . wp_basename( $filename, ".$ext" ) . ".{$new_ext}";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $mime_type && ( $mime_type !== $this->mime_type ) ) {
+ // The image will be converted when saving. Set the quality for the new mime-type if not already set.
+ if ( $mime_type !== $this->output_mime_type ) {
+ $this->output_mime_type = $mime_type;
+ $this->set_quality();
+ }
+ } elseif ( ! empty( $this->output_mime_type ) ) {
+ // Reset output_mime_type and quality.
+ $this->output_mime_type = null;
+ $this->set_quality();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return array( $filename, $new_ext, $mime_type );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="branches58testsphpunitincludesmockimageeditorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.8/tests/phpunit/includes/mock-image-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.8/tests/phpunit/includes/mock-image-editor.php 2021-09-01 00:33:28 UTC (rev 51711)
+++ branches/5.8/tests/phpunit/includes/mock-image-editor.php 2021-09-01 00:43:39 UTC (rev 51712)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,6 +56,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> public function save( $destfilename = null, $mime_type = null ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set new mime-type and quality if converting the image.
+ $this->get_output_format( $destfilename, $mime_type );
</ins><span class="cx" style="display: block; padding: 0 10px"> return self::$save_return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> public function stream( $mime_type = null ) {
</span></span></pre></div>
<a id="branches58testsphpunittestsimageeditorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.8/tests/phpunit/tests/image/editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.8/tests/phpunit/tests/image/editor.php 2021-09-01 00:33:28 UTC (rev 51711)
+++ branches/5.8/tests/phpunit/tests/image/editor.php 2021-09-01 00:43:39 UTC (rev 51712)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -111,6 +111,92 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test test_quality when converting image
+ *
+ * @ticket 6821
+ */
+ public function test_set_quality_with_image_conversion() {
+ $editor = wp_get_image_editor( DIR_TESTDATA . '/images/test-image.png' );
+ $editor->set_mime_type( 'image/png' ); // Ensure mime-specific filters act properly.
+
+ // Set conversions for uploaded images.
+ add_filter( 'image_editor_output_format', array( $this, 'image_editor_output_formats' ) );
+
+ // Quality setting for the source image. For PNG the fallback default of 82 is used.
+ $this->assertSame( 82, $editor->get_quality(), 'Default quality setting is 82.' );
+
+ // Quality should change to the output format's value.
+ // A PNG image will be converted to WEBP whose quialty should be 86.
+ $editor->save();
+ $this->assertSame( 86, $editor->get_quality(), 'Output image format is WEBP. Quality setting for it should be 86.' );
+
+ // Removing PNG to WEBP conversion on save. Quality setting should reset to the default.
+ remove_filter( 'image_editor_output_format', array( $this, 'image_editor_output_formats' ) );
+ $editor->save();
+ $this->assertSame( 82, $editor->get_quality(), 'After removing image conversion quality setting should reset to the default of 82.' );
+
+ unset( $editor );
+
+ // Set conversions for uploaded images.
+ add_filter( 'image_editor_output_format', array( $this, 'image_editor_output_formats' ) );
+ // Change the quality values.
+ add_filter( 'wp_editor_set_quality', array( $this, 'image_editor_change_quality' ), 10, 2 );
+
+ // Get a new editor to clear quality state.
+ $editor = wp_get_image_editor( DIR_TESTDATA . '/images/test-image.jpg' );
+ $editor->set_mime_type( 'image/jpeg' );
+
+ $this->assertSame( 56, $editor->get_quality(), 'Filtered default quality for JPEG is 56.' );
+
+ // Quality should change to the output format's value as filtered above.
+ // A JPEG image will be converted to WEBP whose quialty should be 42.
+ $editor->save();
+ $this->assertSame( 42, $editor->get_quality(), 'Image conversion from JPEG to WEBP. Filtered WEBP quality shoild be 42.' );
+
+ // After removing the conversion the quality setting should reset to the filtered value for the original image type, JPEG.
+ remove_filter( 'image_editor_output_format', array( $this, 'image_editor_output_formats' ) );
+ $editor->save();
+ $this->assertSame(
+ 56,
+ $editor->get_quality(),
+ 'After removing image conversion the quality setting should reset to the filtered value for JPEG, 56.'
+ );
+
+ remove_filter( 'wp_editor_set_quality', array( $this, 'image_editor_change_quality' ) );
+ }
+
+ /**
+ * Changes the output format when editing images. PNG and JPEG files
+ * will be converted to WEBP (if the image editor in PHP supports it).
+ *
+ * @param array $formats
+ *
+ * @return array
+ */
+ public function image_editor_output_formats( $formats ) {
+ $formats['image/png'] = 'image/webp';
+ $formats['image/jpeg'] = 'image/webp';
+ return $formats;
+ }
+
+ /**
+ * Changes the quality according to the mime-type.
+ *
+ * @param int $quality Default quality.
+ * @param string $mime_type Image mime-type.
+ * @return int The changed quality.
+ */
+ public function image_editor_change_quality( $quality, $mime_type ) {
+ if ( 'image/jpeg' === $mime_type ) {
+ return 56;
+ } elseif ( 'image/webp' === $mime_type ) {
+ return 42;
+ } else {
+ return 30;
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test generate_filename
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 6821
</span></span></pre>
</div>
</div>
</body>
</html>