<!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>[42704] trunk/src/wp-includes/media.php: Media: Pass original attribute values to `img_caption_shortcode_width` filter instead of markup pieces.</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/42704">42704</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/42704","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>2018-02-12 21:36:36 +0000 (Mon, 12 Feb 2018)</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: Pass original attribute values to `img_caption_shortcode_width` filter instead of markup pieces.
Add `caption_id` to the list of documented `[caption]` shortcode attributes.
See <a href="https://core.trac.wordpress.org/ticket/34595">#34595</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 2018-02-12 21:11:13 UTC (rev 42703)
+++ trunk/src/wp-includes/media.php 2018-02-12 21:36:36 UTC (rev 42704)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1493,20 +1493,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * filter is {@see 'img_caption_shortcode'} and passes an empty string, the attr
</span><span class="cx" style="display: block; padding: 0 10px"> * parameter and the content parameter values.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The supported attributes for the shortcode are 'id', 'align', 'width', and
- * 'caption'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The supported attributes for the shortcode are 'id', 'caption_id', 'align',
+ * 'width', 'caption', and 'class'.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.9.0 The `class` attribute was added.
+ * @since 5.0.0 The `caption_id` attribute was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $attr {
</span><span class="cx" style="display: block; padding: 0 10px"> * Attributes of the caption shortcode.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $id ID of the div element for the caption.
- * @type string $align Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft',
- * 'aligncenter', alignright', 'alignnone'.
- * @type int $width The width of the caption, in pixels.
- * @type string $caption The caption text.
- * @type string $class Additional class name(s) added to the caption container.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $id ID of the image and caption container element, i.e. <figure> or <div>.
+ * @type string $caption_id ID of the caption element, i.e. <figcaption> or <p>.
+ * @type string $align Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft',
+ * 'aligncenter', alignright', 'alignnone'.
+ * @type int $width The width of the caption, in pixels.
+ * @type string $caption The caption text.
+ * @type string $class Additional class name(s) added to the caption container.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $content Shortcode content.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML content to display the caption.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1558,19 +1561,21 @@
</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 ( $atts['id'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $att_id = esc_attr( sanitize_html_class( $atts['id'] ) );
- $atts['id'] = 'id="' . $att_id . '" ';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $atts['id'] = sanitize_html_class( $atts['id'] );
+ $id = 'id="' . esc_attr( $atts['id'] ) . '" ';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $atts['caption_id'] ) {
- $atts['caption_id'] = 'caption-' . str_replace( '_', '-', $att_id );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $atts['caption_id'] ) {
+ $atts['caption_id'] = sanitize_html_class( $atts['caption_id'] );
+ } elseif ( $atts['id'] ) {
+ $atts['caption_id'] = 'caption-' . str_replace( '_', '-', $atts['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"> $describedby = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $atts['caption_id'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $describedby = 'aria-describedby="' . $atts['caption_id'] . '" ';
- $atts['caption_id'] = 'id="' . $atts['caption_id'] . '" ';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $caption_id = 'id="' . esc_attr( $atts['caption_id'] ) . '" ';
+ $describedby = 'aria-describedby="' . esc_attr( $atts['caption_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"> $class = trim( 'wp-caption ' . $atts['align'] . ' ' . $atts['class'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1604,27 +1609,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $html5 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $html = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<figure %s%s%sclass="%s">%s%s</figure>',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $atts['id'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $id,
</ins><span class="cx" style="display: block; padding: 0 10px"> $describedby,
</span><span class="cx" style="display: block; padding: 0 10px"> $style,
</span><span class="cx" style="display: block; padding: 0 10px"> esc_attr( $class ),
</span><span class="cx" style="display: block; padding: 0 10px"> do_shortcode( $content ),
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<figcaption %sclass="wp-caption-text">%s</figcaption>',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $atts['caption_id'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $caption_id,
</ins><span class="cx" style="display: block; padding: 0 10px"> $atts['caption']
</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"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $html = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<div %s%sclass="%s">%s%s</div>',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $atts['id'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $id,
</ins><span class="cx" style="display: block; padding: 0 10px"> $style,
</span><span class="cx" style="display: block; padding: 0 10px"> esc_attr( $class ),
</span><span class="cx" style="display: block; padding: 0 10px"> str_replace( '<img ', '<img ' . $describedby, do_shortcode( $content ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<p %sclass="wp-caption-text">%s</p>',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $atts['caption_id'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $caption_id,
</ins><span class="cx" style="display: block; padding: 0 10px"> $atts['caption']
</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>