<!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>[41732] trunk: Customizer: Minimize duplicate header crops in the media library.</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" 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/41732">41732</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/41732","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joemcgill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-04 14:58:07 +0000 (Wed, 04 Oct 2017)</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'>Customizer: Minimize duplicate header crops in the media library.
This adds `Custom_Image_Header::get_previous_crop()`, which finds any
previously cropped headers created from the same base image and replaces
that attachment rather than creating a new attachment.
After updating a crop, the replaced images is also removed from the list
of previous header images in the Customizer.
See <a href="https://core.trac.wordpress.org/ticket/21819">#21819</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmincustomheaderphp">trunk/src/wp-admin/custom-header.php</a></li>
<li><a href="#trunksrcwpincludesjscustomizemodelsjs">trunk/src/wp-includes/js/customize-models.js</a></li>
<li><a href="#trunksrcwpincludesthemephp">trunk/src/wp-includes/theme.php</a></li>
<li><a href="#trunktestsphpunittestsimageheaderphp">trunk/tests/phpunit/tests/image/header.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmincustomheaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/custom-header.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/custom-header.php 2017-10-04 14:51:03 UTC (rev 41731)
+++ trunk/src/wp-admin/custom-header.php 2017-10-04 14:58:07 UTC (rev 41732)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1164,7 +1164,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_title' => basename($cropped),
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_mime_type' => $image_type,
</span><span class="cx" style="display: block; padding: 0 10px"> 'guid' => $url,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'context' => 'custom-header'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'context' => 'custom-header',
+ 'post_parent' => $parent_attachment_id,
</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"> return $object;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1180,8 +1181,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int Attachment ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> final public function insert_attachment( $object, $cropped ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $parent_id = isset( $object['post_parent'] ) ? $object['post_parent'] : null;
+ unset( $object['post_parent'] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $attachment_id = wp_insert_attachment( $object, $cropped );
</span><span class="cx" style="display: block; padding: 0 10px"> $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the header image attachment metadata.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1193,6 +1198,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $metadata = apply_filters( 'wp_header_image_attachment_metadata', $metadata );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_update_attachment_metadata( $attachment_id, $metadata );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( $parent_id ) {
+ $meta = add_post_meta( $attachment_id, '_wp_attachment_parent', $parent_id, true );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $attachment_id;
</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">@@ -1241,8 +1251,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $object = $this->create_attachment_object( $cropped, $attachment_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $object['ID'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $previous = $this->get_previous_crop( $object );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $previous ) {
+ $object['ID'] = $previous;
+ } else {
+ unset( $object['ID'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $new_attachment_id = $this->insert_attachment( $object, $cropped );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $object['attachment_id'] = $new_attachment_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1396,4 +1412,32 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $header_images;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Get the ID of a previous crop from the same base image.
+ *
+ * @since 4.9.0
+ *
+ * @param array $object A crop attachment object.
+ * @return int|false An attachment ID if one exists. False if none.
+ */
+ public function get_previous_crop( $object ) {
+ $header_images = $this->get_uploaded_header_images();
+
+ // Bail early if there are no header images.
+ if ( empty( $header_images ) ) {
+ return false;
+ }
+
+ $previous = false;
+
+ foreach ( $header_images as $image ) {
+ if ( $image['attachment_parent'] === $object['post_parent'] ) {
+ $previous = $image['attachment_id'];
+ break;
+ }
+ }
+
+ return $previous;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesjscustomizemodelsjs"></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/js/customize-models.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/customize-models.js 2017-10-04 14:51:03 UTC (rev 41731)
+++ trunk/src/wp-includes/js/customize-models.js 2017-10-04 14:58:07 UTC (rev 41732)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,6 +164,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> this.on('control:setImage', this.setImage, this);
</span><span class="cx" style="display: block; padding: 0 10px"> this.on('control:removeImage', this.removeImage, this);
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ this.on('add', this.maybeRemoveOldCrop, this);
</ins><span class="cx" style="display: block; padding: 0 10px"> this.on('add', this.maybeAddRandomChoice, this);
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> _.each(this.data, function(elt, index) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,6 +188,25 @@
</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">+ maybeRemoveOldCrop: function( model ) {
+ var newID = model.get( 'header' ).attachment_id || false,
+ oldCrop;
+
+ // Bail early if we don't have a new attachment ID.
+ if ( ! newID ) {
+ return;
+ }
+
+ oldCrop = this.find( function( item ) {
+ return ( item.cid !== model.cid && item.get( 'header' ).attachment_id === newID );
+ } );
+
+ // If we found an old crop, remove it from the collection.
+ if ( oldCrop ) {
+ this.remove( oldCrop );
+ }
+ },
+
</ins><span class="cx" style="display: block; padding: 0 10px"> maybeAddRandomChoice: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> if (this.size() === 1) {
</span><span class="cx" style="display: block; padding: 0 10px"> this.addRandomChoice();
</span></span></pre></div>
<a id="trunksrcwpincludesthemephp"></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/theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/theme.php 2017-10-04 14:51:03 UTC (rev 41731)
+++ trunk/src/wp-includes/theme.php 2017-10-04 14:58:07 UTC (rev 41732)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1214,6 +1214,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $header_images[$header_index]['url'] = $url;
</span><span class="cx" style="display: block; padding: 0 10px"> $header_images[$header_index]['thumbnail_url'] = $url;
</span><span class="cx" style="display: block; padding: 0 10px"> $header_images[$header_index]['alt_text'] = get_post_meta( $header->ID, '_wp_attachment_image_alt', true );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $header_images[$header_index]['attachment_parent'] = (int) get_post_meta( $header->ID, '_wp_attachment_parent', true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $header_data['width'] ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $header_images[$header_index]['width'] = $header_data['width'];
</span></span></pre></div>
<a id="trunktestsphpunittestsimageheaderphp"></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/header.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/image/header.php 2017-10-04 14:51:03 UTC (rev 41731)
+++ trunk/tests/phpunit/tests/image/header.php 2017-10-04 14:58:07 UTC (rev 41732)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,4 +137,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertGreaterThan( 0, $cropped_id );
</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">+ /**
+ * @ticket 21819
+ */
+ function test_check_get_previous_crop() {
+ $id = wp_insert_attachment( array(
+ 'post_status' => 'publish',
+ 'post_title' => 'foo.png',
+ 'post_type' => 'post',
+ 'guid' => 'http://localhost/foo.png'
+ ) );
+
+ // Create inital crop object.
+ $cropped_1 = 'foo-cropped-1.png';
+ $object = $this->custom_image_header->create_attachment_object( $cropped_1, $id );
+
+ // Ensure no previous crop exists.
+ $previous = $this->custom_image_header->get_previous_crop( $object );
+ $this->assertFalse( $previous );
+
+ // Create the inital crop attachment and set it as the header.
+ $cropped_1_id = $this->custom_image_header->insert_attachment( $object, $cropped_1 );
+ $key = '_wp_attachment_custom_header_last_used_' . get_stylesheet();
+ update_post_meta( $cropped_1_id, $key, time() );
+ update_post_meta( $cropped_1_id, '_wp_attachment_is_custom_header', get_stylesheet() );
+
+ // Create second crop.
+ $cropped_2 = 'foo-cropped-2.png';
+ $object = $this->custom_image_header->create_attachment_object( $cropped_2, $id );
+
+ // Test that a previous crop is found.
+ $previous = $this->custom_image_header->get_previous_crop( $object );
+ $this->assertSame( $previous, $cropped_1_id );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>