<!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>[38296] trunk: Media: use `wp_get_attachment_metadata()` instead of `get_post_meta()` where appropriate.</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/38296">38296</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/38296","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-08-21 06:14:37 +0000 (Sun, 21 Aug 2016)</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: use `wp_get_attachment_metadata()` instead of `get_post_meta()` where appropriate.
Adds unit test.
Props JorritSchippers.
Fixes <a href="https://core.trac.wordpress.org/ticket/36246">#36246</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunktestsphpunittestsmediaphp">trunk/tests/phpunit/tests/media.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2016-08-20 23:44:07 UTC (rev 38295)
+++ trunk/src/wp-includes/media.php 2016-08-21 06:14:37 UTC (rev 38296)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -861,7 +861,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Generate 'srcset' and 'sizes' if not already present.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $attr['srcset'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $image_meta = wp_get_attachment_metadata( $attachment_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $image_meta ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $size_array = array( absint( $width ), absint( $height ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -990,7 +990,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 ( ! is_array( $image_meta ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $image_meta = wp_get_attachment_metadata( $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"> $image_src = $image[0];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1206,7 +1206,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 ( ! is_array( $image_meta ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $image_meta = wp_get_attachment_metadata( $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"> $image_src = $image[0];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1239,7 +1239,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $width = absint( $size[0] );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_string( $size ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $image_meta && $attachment_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $image_meta = wp_get_attachment_metadata( $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"> if ( is_array( $image_meta ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1314,7 +1314,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"> foreach ( $selected_images as $image => $attachment_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $image_meta = wp_get_attachment_metadata( $attachment_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( $image, wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ), $content );
</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="trunktestsphpunittestsmediaphp"></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/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/media.php 2016-08-20 23:44:07 UTC (rev 38295)
+++ trunk/tests/phpunit/tests/media.php 2016-08-21 06:14:37 UTC (rev 38296)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1755,6 +1755,38 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, get_image_send_to_editor( $id, $caption, $title, $align, $url, $rel, $size, $alt ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests if wp_get_attachment_image() uses wp_get_attachment_metadata().
+ *
+ * In this way, the meta data can be filtered using the filter
+ * `wp_get_attachment_metadata`.
+ *
+ * The test checks if the image size that is added in the filter is
+ * used in the output of `wp_get_attachment_image()`.
+ *
+ * @ticket 36246
+ */
+ function test_wp_get_attachment_image_should_use_wp_get_attachment_metadata() {
+ add_filter( 'wp_get_attachment_metadata', array( $this, '_filter_36246' ), 10, 2 );
+
+ $actual = wp_get_attachment_image( self::$large_id, 'testsize' );
+ $expected = '<img width="999" height="999" src="http://example.org/wp-content/uploads/2016/03/test-image-testsize-999x999.png" class="attachment-testsize size-testsize" alt="test-image-large.png" srcset="http://example.org/wp-content/uploads/2016/03/test-image-large-150x150.png 150w, http://example.org/wp-content/uploads/2016/03/test-image-testsize-999x999.png 999w" sizes="(max-width: 999px) 100vw, 999px" />';
+
+ remove_filter( 'wp_get_attachment_metadata', array( $this, '_filter_36246' ) );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ function _filter_36246( $data, $attachment_id ) {
+ $data['sizes']['testsize'] = array(
+ 'file' => 'test-image-testsize-999x999.png',
+ 'width' => 999,
+ 'height' => 999,
+ 'mime-type' => 'image/png',
+ );
+ return $data;
+ }
</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>