<!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>[46077] trunk: Media: Improve handling of cases where an uploaded image matches exactly a defined intermediate size.</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/46077">46077</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/46077","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>azaozz</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-07 01:33:16 +0000 (Sat, 07 Sep 2019)</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: Improve handling of cases where an uploaded image matches exactly a defined intermediate size. In most of these cases the original image has been edited by the user and is "web ready", there is no need for an identical intermediate image.
Introduces the `wp_image_resize_identical_dimensions` filter so plugins and themes can determine whether a new image with identical dimensions should be created, defaults to false.
Props wpdennis, HKandulla, galbaras, azaozz.
See <a href="https://core.trac.wordpress.org/ticket/32437">#32437</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunktestsphpunittestsimagedimensionsphp">trunk/tests/phpunit/tests/image/dimensions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2019-09-07 01:06:49 UTC (rev 46076)
+++ trunk/src/wp-includes/functions.php 2019-09-07 01:33:16 UTC (rev 46077)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7316,3 +7316,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function is_php_version_compatible( $required ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return empty( $required ) || version_compare( phpversion(), $required, '>=' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Check if two numbers are nearly the same.
+ *
+ * This is similar to using `round()` but the precision is more fine-grained.
+ *
+ * @since 5.3.0
+ *
+ * @param int|float $expected The expected value.
+ * @param int|float $actual The actual number.
+ * @param int|float $precision The allowed variation.
+ * @return bool Whether the numbers match whithin the specified precision.
+ */
+function wp_fuzzy_number_match( $expected, $actual, $precision = 1 ) {
+ return abs( (float) $expected - (float) $actual ) <= $precision;
+}
</ins></span></pre></div>
<a id="trunksrcwpincludesmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media.php 2019-09-07 01:06:49 UTC (rev 46076)
+++ trunk/src/wp-includes/media.php 2019-09-07 01:33:16 UTC (rev 46077)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -543,8 +543,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $output;
</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">+ // Stop if the destination size is larger than the original image dimensions.
+ if ( empty( $dest_h ) ) {
+ if ( $orig_w < $dest_w ) {
+ return false;
+ }
+ } elseif ( empty( $dest_w ) ) {
+ if ( $orig_h < $dest_h ) {
+ return false;
+ }
+ } else {
+ if ( $orig_w < $dest_w && $orig_h < $dest_h ) {
+ return false;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $crop ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // crop the largest possible portion of the original image that we can size to $dest_w x $dest_h
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Crop the largest possible portion of the original image that we can size to $dest_w x $dest_h.
+ // Note that the requested crop dimensions are used as a maximum bounding box for the original image.
+ // If the original image's width or height is less than the requested width or height
+ // only the greater one will be cropped.
+ // For example when the original image is 600x300, and the requested crop dimensions are 400x400,
+ // the resulting image will be 400x300.
</ins><span class="cx" style="display: block; padding: 0 10px"> $aspect_ratio = $orig_w / $orig_h;
</span><span class="cx" style="display: block; padding: 0 10px"> $new_w = min( $dest_w, $orig_w );
</span><span class="cx" style="display: block; padding: 0 10px"> $new_h = min( $dest_h, $orig_h );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -584,7 +604,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $s_y = floor( ( $orig_h - $crop_h ) / 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // don't crop, just resize using $dest_w x $dest_h as a maximum bounding box
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Resize using $dest_w x $dest_h as a maximum bounding box.
</ins><span class="cx" style="display: block; padding: 0 10px"> $crop_w = $orig_w;
</span><span class="cx" style="display: block; padding: 0 10px"> $crop_h = $orig_h;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -594,15 +614,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> list( $new_w, $new_h ) = wp_constrain_dimensions( $orig_w, $orig_h, $dest_w, $dest_h );
</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 the resulting image would be the same size or larger we don't want to resize it
- if ( $new_w >= $orig_w && $new_h >= $orig_h && intval( $dest_w ) !== intval( $orig_w ) && intval( $dest_h ) !== intval( $orig_h ) ) {
- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_fuzzy_number_match( $new_w, $orig_w ) && wp_fuzzy_number_match( $new_h, $orig_h ) ) {
+ // The new size has virtually the same dimensions as the original image.
+
+ /**
+ * Filters whether to proceed with making an image sub-size with identical dimensions
+ * with the original/source image. Differences of 1px may be due to rounding and are ignored.
+ *
+ * @since 5.3.0
+ *
+ * @param bool The filtered value.
+ * @param int Original image width.
+ * @param int Original image height.
+ */
+ $proceed = (bool) apply_filters( 'wp_image_resize_identical_dimensions', false, $orig_w, $orig_h );
+
+ if ( ! $proceed ) {
+ return false;
+ }
</ins><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">- // the return array matches the parameters to imagecopyresampled()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The return array matches the parameters to imagecopyresampled().
</ins><span class="cx" style="display: block; padding: 0 10px"> // int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h
</span><span class="cx" style="display: block; padding: 0 10px"> return array( 0, 0, (int) $s_x, (int) $s_y, (int) $new_w, (int) $new_h, (int) $crop_w, (int) $crop_h );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><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">@@ -664,7 +698,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 the image dimensions are within 1px of the expected size, we consider it a match.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $matched = ( abs( $constrained_size[0] - $expected_size[0] ) <= 1 && abs( $constrained_size[1] - $expected_size[1] ) <= 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $matched = ( wp_fuzzy_number_match( $constrained_size[0], $expected_size[0] ) && wp_fuzzy_number_match( $constrained_size[1], $expected_size[1] ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $matched;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsimagedimensionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/image/dimensions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/image/dimensions.php 2019-09-07 01:06:49 UTC (rev 46076)
+++ trunk/tests/phpunit/tests/image/dimensions.php 2019-09-07 01:33:16 UTC (rev 46077)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -131,6 +131,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_640x480() {
</span><span class="cx" style="display: block; padding: 0 10px"> // crop 640x480 to fit 640x480 (no change)
</span><span class="cx" style="display: block; padding: 0 10px"> $out = image_resize_dimensions( 640, 480, 640, 480, true );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertFalse( $out );
+
+ // resize 640x480 to fit 640x480 (no change)
+ $out = image_resize_dimensions( 640, 480, 640, 480, false );
+ $this->assertFalse( $out );
+
+ // Test with the filter override.
+ add_filter( 'wp_image_resize_identical_dimensions', '__return_true' );
+
+ // crop 640x480 to fit 640x480 (no change)
+ $out = image_resize_dimensions( 640, 480, 640, 480, true );
</ins><span class="cx" style="display: block; padding: 0 10px"> // dst_x, dst_y, src_x, src_y, dst_w, dst_h, src_w, src_h
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( 0, 0, 0, 0, 640, 480, 640, 480 ), $out );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,6 +149,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $out = image_resize_dimensions( 640, 480, 640, 480, false );
</span><span class="cx" style="display: block; padding: 0 10px"> // dst_x, dst_y, src_x, src_y, dst_w, dst_h, src_w, src_h
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( 0, 0, 0, 0, 640, 480, 640, 480 ), $out );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ remove_filter( 'wp_image_resize_identical_dimensions', '__return_true' );
</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></pre>
</div>
</div>
</body>
</html>