<!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>[27472] trunk: Allow $crop in add_image_size() to receive crop anchors (top, left, right, bottom, center).</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/27472">27472</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2014-03-08 06:13:27 +0000 (Sat, 08 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Allow $crop in add_image_size() to receive crop anchors (top, left, right, bottom, center).
This also applies to set_post_thumbnail_size() and image_resize_dimensions().
props bradt, wonderboymusic, DH-Shredder.
fixes <a href="http://core.trac.wordpress.org/ticket/19393">#19393</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesimagephp">trunk/src/wp-admin/includes/image.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="trunksrcwpadminincludesimagephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/image.php (27471 => 27472)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/image.php 2014-03-08 04:19:24 UTC (rev 27471)
+++ trunk/src/wp-admin/includes/image.php 2014-03-08 06:13:27 UTC (rev 27472)
</span><span class="lines">@@ -97,7 +97,7 @@
</span><span class="cx"> else
</span><span class="cx"> $sizes[$s]['height'] = get_option( "{$s}_size_h" ); // For default sizes set in options
</span><span class="cx"> if ( isset( $_wp_additional_image_sizes[$s]['crop'] ) )
</span><del>- $sizes[$s]['crop'] = intval( $_wp_additional_image_sizes[$s]['crop'] ); // For theme-added sizes
</del><ins>+ $sizes[$s]['crop'] = $_wp_additional_image_sizes[$s]['crop']; // For theme-added sizes
</ins><span class="cx"> else
</span><span class="cx"> $sizes[$s]['crop'] = get_option( "{$s}_crop" ); // For default sizes set in options
</span><span class="cx"> }
</span></span></pre></div>
<a id="trunksrcwpincludesmediaphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/media.php (27471 => 27472)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/media.php 2014-03-08 04:19:24 UTC (rev 27471)
+++ trunk/src/wp-includes/media.php 2014-03-08 06:13:27 UTC (rev 27472)
</span><span class="lines">@@ -183,19 +183,30 @@
</span><span class="cx"> /**
</span><span class="cx"> * Register a new image size.
</span><span class="cx"> *
</span><ins>+ * Cropping behavior for the image size is dependent on the value of $crop:
+ * 1. If false (default), images will be scaled, not cropped.
+ * 2. If an array in the form of array( x_crop_position, y_crop_position ):
+ * - x_crop_position accepts 'left' 'center', or 'right'.
+ * - y_crop_position accepts 'top', 'center', or 'bottom'.
+ * Images will be cropped to the specified dimensions within the defined crop area.
+ * 3. If true, images will be cropped to the specified dimensions using center positions.
+ *
</ins><span class="cx"> * @since 2.9.0
</span><span class="cx"> *
</span><del>- * @param string $name The image size name.
- * @param int $width The image's width.
- * @param int $height The image's width.
- * @param bool $width Whether to crop the image to fit the dimensions. Default false.
</del><ins>+ * @param string $name Image size identifier.
+ * @param int $width Image width in pixels.
+ * @param int $height Image height in pixels.
+ * @param bool|array $crop Optional. Whether to crop images to specified height and width or resize.
+ * An array can specify positioning of the crop area. Default false.
+ * @return bool|array False, if no image was created. Metadata array on success.
</ins><span class="cx"> */
</span><span class="cx"> function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
</span><span class="cx"> global $_wp_additional_image_sizes;
</span><ins>+
</ins><span class="cx"> $_wp_additional_image_sizes[ $name ] = array(
</span><span class="cx"> 'width' => absint( $width ),
</span><span class="cx"> 'height' => absint( $height ),
</span><del>- 'crop' => (bool) $crop,
</del><ins>+ 'crop' => $crop,
</ins><span class="cx"> );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -233,9 +244,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Registers an image size for the post thumbnail
</del><ins>+ * Registers an image size for the post thumbnail.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.9.0
</span><ins>+ * @see add_image_size() for details on cropping behavior.
+ *
+ * @param int $width Image width in pixels.
+ * @param int $height Image height in pixels.
+ * @param bool|array $crop Optional. Whether to crop images to specified height and width or resize.
+ * An array can specify positioning of the crop area. Default false.
+ * @return bool|array False, if no image was created. Metadata array on success.
</ins><span class="cx"> */
</span><span class="cx"> function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
</span><span class="cx"> add_image_size( 'post-thumbnail', $width, $height, $crop );
</span><span class="lines">@@ -342,22 +360,30 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve calculated resized dimensions for use in WP_Image_Editor.
</del><ins>+ * Retrieve calculated resize dimensions for use in WP_Image_Editor.
</ins><span class="cx"> *
</span><del>- * Calculate dimensions and coordinates for a resized image that fits within a
- * specified width and height. If $crop is true, the largest matching central
- * portion of the image will be cropped out and resized to the required size.
</del><ins>+ * Calculates dimensions and coordinates for a resized image that fits
+ * within a specified width and height.
</ins><span class="cx"> *
</span><ins>+ * Cropping behavior is dependent on the value of $crop:
+ * 1. If false (default), images will not be cropped.
+ * 2. If an array in the form of array( x_crop_position, y_crop_position ):
+ * - x_crop_position accepts 'left' 'center', or 'right'.
+ * - y_crop_position accepts 'top', 'center', or 'bottom'.
+ * Images will be cropped to the specified dimensions within the defined crop area.
+ * 3. If true, images will be cropped to the specified dimensions using center positions.
+ *
</ins><span class="cx"> * @since 2.5.0
</span><del>- * @uses apply_filters() Calls 'image_resize_dimensions' on $orig_w, $orig_h, $dest_w, $dest_h and
- * $crop to provide custom resize dimensions.
</del><ins>+ * @uses apply_filters() Calls 'image_resize_dimensions' on $orig_w, $orig_h, $dest_w,
+ * $dest_h and $crop to provide custom resize dimensions.
</ins><span class="cx"> *
</span><del>- * @param int $orig_w Original width.
- * @param int $orig_h Original height.
- * @param int $dest_w New width.
- * @param int $dest_h New height.
- * @param bool $crop Optional, default is false. Whether to crop image or resize.
- * @return bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function.
</del><ins>+ * @param int $orig_w Original width in pixels.
+ * @param int $orig_h Original height in pixels.
+ * @param int $dest_w New width in pixels.
+ * @param int $dest_h New height in pixels.
+ * @param bool|array $crop Optional. Whether to crop image to specified height and width or resize.
+ * An array can specify positioning of the crop area. Default false.
+ * @return bool|array False on failure. Returned array matches parameters for `imagecopyresampled()`.
</ins><span class="cx"> */
</span><span class="cx"> function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) {
</span><span class="cx">
</span><span class="lines">@@ -391,8 +417,27 @@
</span><span class="cx"> $crop_w = round($new_w / $size_ratio);
</span><span class="cx"> $crop_h = round($new_h / $size_ratio);
</span><span class="cx">
</span><del>- $s_x = floor( ($orig_w - $crop_w) / 2 );
- $s_y = floor( ($orig_h - $crop_h) / 2 );
</del><ins>+ if ( ! is_array( $crop ) || count( $crop ) !== 2 ) {
+ $crop = array( 'center', 'center' );
+ }
+
+ list( $x, $y ) = $crop;
+
+ if ( 'left' === $x ) {
+ $s_x = 0;
+ } elseif ( 'right' === $x ) {
+ $s_x = $orig_w - $crop_w;
+ } else {
+ $s_x = floor( ( $orig_w - $crop_w ) / 2 );
+ }
+
+ if ( 'top' === $y ) {
+ $s_y = 0;
+ } elseif ( 'bottom' === $y ) {
+ $s_y = $orig_h - $crop_h;
+ } else {
+ $s_y = floor( ( $orig_h - $crop_h ) / 2 );
+ }
</ins><span class="cx"> } else {
</span><span class="cx"> // don't crop, just resize using $dest_w x $dest_h as a maximum bounding box
</span><span class="cx"> $crop_w = $orig_w;
</span></span></pre></div>
<a id="trunktestsphpunittestsimagedimensionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/image/dimensions.php (27471 => 27472)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/image/dimensions.php 2014-03-08 04:19:24 UTC (rev 27471)
+++ trunk/tests/phpunit/tests/image/dimensions.php 2014-03-08 06:13:27 UTC (rev 27472)
</span><span class="lines">@@ -128,4 +128,33 @@
</span><span class="cx"> $this->assertEquals( array(0, 0, 0, 20, 400, 500, 480, 600), $out );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * @ticket 19393
+ */
+ function test_crop_anchors() {
+ // landscape: crop 640x480 to fit 400x500: 400x400 taken from a 480x480 crop
+ // src_x = 0 (left), src_y = 0 (top)
+ $out = image_resize_dimensions(640, 480, 400, 500, array( 'left', 'top' ) );
+ // dst_x, dst_y, src_x, src_y, dst_w, dst_h, src_w, src_h
+ $this->assertEquals( array(0, 0, 0, 0, 400, 480, 400, 480), $out );
+
+ // portrait: resize 480x640 to fit 400x400: 400x400 taken from a 480x480 crop
+ // src_x = 0 (left), src_y = 0 (top)
+ $out = image_resize_dimensions(480, 640, 400, 500, array( 'left', 'top' ) );
+ // dst_x, dst_y, src_x, src_y, dst_w, dst_h, src_w, src_h
+ $this->assertEquals( array(0, 0, 0, 0, 400, 500, 480, 600), $out );
+
+ // landscape: crop 640x480 to fit 400x500: 400x400 taken from a 480x480 crop
+ // src_x = 240 (left), src_y = 0 (due to landscape crop)
+ $out = image_resize_dimensions(640, 480, 400, 500, array( 'right', 'bottom' ) );
+ // dst_x, dst_y, src_x, src_y, dst_w, dst_h, src_w, src_h
+ $this->assertEquals( array(0, 0, 240, 0, 400, 480, 400, 480), $out );
+
+ // portrait: resize 480x640 to fit 400x400: 400x400 taken from a 480x480 crop
+ // src_x = 0 (due to portrait crop), src_y = 40 (bottom)
+ $out = image_resize_dimensions(480, 640, 400, 500, array( 'right', 'bottom' ) );
+ // dst_x, dst_y, src_x, src_y, dst_w, dst_h, src_w, src_h
+ $this->assertEquals( array(0, 0, 0, 40, 400, 500, 480, 600), $out );
+ }
+
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>