<!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>[35289] trunk/src/wp-includes/media.php: Media: Introduce the `image_get_intermediate_size` filter to its like-named function, making it possible to manipulate returned intermedia image size data.</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/35289">35289</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/35289","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-10-20 07:23:18 +0000 (Tue, 20 Oct 2015)</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: Introduce the `image_get_intermediate_size` filter to its like-named function, making it possible to manipulate returned intermedia image size data.
Covers both the default and meaningful short-circuit return cases. Also adds a hash notation to the return documentation in the DocBlock.
Props A5hleyRich, DH-Shredder, wonderboymusic.
Fixes <a href="https://core.trac.wordpress.org/ticket/34124">#34124</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/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 2015-10-20 07:08:59 UTC (rev 35288)
+++ trunk/src/wp-includes/media.php 2015-10-20 07:23:18 UTC (rev 35289)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -607,7 +607,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $size Optional. Image size. Accepts any valid image size, or an array
</span><span class="cx" style="display: block; padding: 0 10px"> * of width and height values in pixels (in that order).
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'thumbnail'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return false|array False on failure or array of file path, width, and height on success.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return false|array $data {
+ * Array of file relative path, width, and height on success. Additionally includes absolute
+ * path and URL if registered size is passed to $size parameter. False on failure.
+ *
+ * @type string $file Image's path relative to uploads directory
+ * @type int $width Width of image
+ * @type int $height Height of image
+ * @type string $path Optional. Image's absolute filesystem path. Only returned if registered
+ * size is passed to `$size` parameter.
+ * @type string $url Optional. Image's URL. Only returned if registered size is passed to `$size`
+ * parameter.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -620,9 +631,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $imagedata['sizes'] as $_size => $data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // If there's an exact match to an existing image size, short circuit.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $data['width'] == $size[0] && $data['height'] == $size[1] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $file = $data['file'];
- list($width, $height) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
- return compact( 'file', 'width', 'height' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
+
+ /** This filter is documented in wp-includes/media.php */
+ return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> // If it's not an exact match but it's at least the dimensions requested.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $data['width'] >= $size[0] && $data['height'] >= $size[1] ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -647,10 +659,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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 we're still here, then we're going to use this size
- $file = $data['file'];
- list( $width, $height ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
- return compact( 'file', 'width', 'height' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If we're still here, then we're going to use this size.
+ list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
+
+ /** This filter is documented in wp-includes/media.php */
+ return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size );
</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">@@ -665,7 +678,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data['path'] = path_join( dirname($imagedata['file']), $data['file'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $data['url'] = path_join( dirname($file_url), $data['file'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $data;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filter the output of image_get_intermediate_size()
+ *
+ * @since 4.4.0
+ *
+ * @see image_get_intermediate_size()
+ *
+ * @param array $data Array of file relative path, width, and height on success. May also include
+ * file absolute path and URL.
+ * @param int $post_id The post_id of the image attachment
+ * @param string|array $size Registered image size or flat array of initially-requested height and width
+ * dimensions (in that order).
+ */
+ return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size );
</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>