<!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>[47249] trunk/src/wp-includes/media.php: Docs: Improve documentation for the `$attr` parameter of `wp_get_attachment_image()`.</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/47249">47249</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/47249","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-02-10 22:01:49 +0000 (Mon, 10 Feb 2020)</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'>Docs: Improve documentation for the `$attr` parameter of `wp_get_attachment_image()`.
Props juanfra, Mte90, DrewAPicture, joemcgill, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/36661">#36661</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 2020-02-10 21:36:53 UTC (rev 47248)
+++ trunk/src/wp-includes/media.php 2020-02-10 22:01:49 UTC (rev 47249)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -363,8 +363,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $id Attachment ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $alt Image Description for the alt attribute.
- * @param string $title Image Description for the title attribute.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $alt Image description for the alt attribute.
+ * @param string $title Image description for the title attribute.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $align Part of the class name for aligning the image.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $size Optional. Registered image size to retrieve a tag for. Accepts any
</span><span class="cx" style="display: block; padding: 0 10px"> * valid image size, or an array of width and height values in pixels
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -402,8 +402,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $html HTML content for the image.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $id Attachment ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $alt Alternate text.
- * @param string $title Attachment title.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $alt Image description for the alt attribute.
+ * @param string $title Image description for the title attribute.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $align Part of the class name for aligning the image.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $size Size of image. Image size or array of width and height values (in that order).
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'medium'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -999,7 +999,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width
</span><span class="cx" style="display: block; padding: 0 10px"> * and height values in pixels (in that order). Default 'thumbnail'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $icon Optional. Whether the image should be treated as an icon. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|array $attr Optional. Attributes for the image markup. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $attr {
+ * Optional. Attributes for the image markup.
+ *
+ * @type string $src Image attachment URL.
+ * @type string $class CSS class name or space-separated list of classes.
+ * Default `attachment-$size_class size-$size_class`,
+ * where `$size_class` is the image size being requested.
+ * @type string $alt Image description for the alt attribute.
+ * @type string $srcset The 'srcset' attribute value.
+ * @type string $sizes The 'sizes' attribute value.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML img element or empty string on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = false, $attr = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1006,9 +1016,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $html = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $image = wp_get_attachment_image_src( $attachment_id, $size, $icon );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $image ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- list($src, $width, $height) = $image;
- $hwstring = image_hwstring( $width, $height );
- $size_class = $size;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $src, $width, $height ) = $image;
+ $hwstring = image_hwstring( $width, $height );
+ $size_class = $size;
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $size_class ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $size_class = join( 'x', $size_class );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1046,6 +1056,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string[] $attr Array of attribute values for the image markup, keyed by attribute name.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * See wp_get_attachment_image().
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $attachment Image attachment post.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $size Requested size. Image size or array of width and height values
</span><span class="cx" style="display: block; padding: 0 10px"> * (in that order). Default 'thumbnail'.
</span></span></pre>
</div>
</div>
</body>
</html>