<!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>[44942] trunk: Accessibility: Ensure embed iframes have a title attribute.</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/44942">44942</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/44942","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>afercia</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-03-20 17:21:56 +0000 (Wed, 20 Mar 2019)</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'>Accessibility: Ensure embed iframes have a title attribute.
Screen reader users rely on the iframe title attribute to describe the contents of iframes. A meaningful title attribute allows to quickly identify the iframe content, so users can determine which iframe to enter and explore in detail or skip if desired.
Note: this is the only case where a title attribute is required for compliance with the W3C Web Content Accessibility Guidelines (WCAG).
- checks for oEmbed response of type `video` or `rich`
- checks if they use an iframe
- fetches the title (if any) from the oEmbed response
- adds the title to the embed iframe
Props bamadesigner, TomHarrigan, swissspidy, jrf, afercia.
Fixes <a href="https://core.trac.wordpress.org/ticket/40245">#40245</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesembedphp">trunk/src/wp-includes/embed.php</a></li>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsoembedfilterTitleAttributesphp">trunk/tests/phpunit/tests/oembed/filterTitleAttributes.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdefaultfiltersphp"></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/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2019-03-20 15:48:46 UTC (rev 44941)
+++ trunk/src/wp-includes/default-filters.php 2019-03-20 17:21:56 UTC (rev 44942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -573,6 +573,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'the_excerpt_embed', 'wp_embed_excerpt_attachment' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'oembed_dataparse', 'wp_filter_oembed_result', 10, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'oembed_dataparse', 'wp_filter_oembed_iframe_title_attribute', 20, 3 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'oembed_response_data', 'get_oembed_response_data_rich', 10, 4 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'pre_oembed_result', 'wp_filter_pre_oembed_result', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesembedphp"></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/embed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/embed.php 2019-03-20 15:48:46 UTC (rev 44941)
+++ trunk/src/wp-includes/embed.php 2019-03-20 17:21:56 UTC (rev 44942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -781,6 +781,55 @@
</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">+ * Filters the given oEmbed HTML to make sure iframes have a title attribute.
+ *
+ * @since 5.2.0
+ *
+ * @param string $result The oEmbed HTML result.
+ * @param object $data A data object result from an oEmbed provider.
+ * @param string $url The URL of the content to be embedded.
+ * @return string The filtered oEmbed result.
+ */
+function wp_filter_oembed_iframe_title_attribute( $result, $data, $url ) {
+ if ( false === $result || ! in_array( $data->type, array( 'rich', 'video' ) ) ) {
+ return $result;
+ }
+
+ $title = ! empty( $data->title ) ? $data->title : '';
+
+ $pattern = '`<iframe[^>]*?title=(\\\\\'|\\\\"|[\'"])([^>]*?)\1`i';
+ $has_title_attr = preg_match( $pattern, $result, $matches );
+
+ if ( $has_title_attr && ! empty( $matches[2] ) ) {
+ $title = $matches[2];
+ }
+
+ /**
+ * Filters the title attribute of the given oEmbed HTML iframe.
+ *
+ * @since 5.2.0
+ *
+ * @param string $title The title attribute.
+ * @param string $result The oEmbed HTML result.
+ * @param object $data A data object result from an oEmbed provider.
+ * @param string $url The URL of the content to be embedded.
+ */
+ $title = apply_filters( 'oembed_iframe_title_attribute', $title, $result, $data, $url );
+
+ if ( '' === $title ) {
+ return $result;
+ }
+
+ if ( $has_title_attr ) {
+ // Remove the old title, $matches[1]: quote, $matches[2]: title attribute value.
+ $result = str_replace( ' title=' . $matches[1] . $matches[2] . $matches[1], '', $result );
+ }
+
+ return str_ireplace( '<iframe ', sprintf( '<iframe title="%s" ', esc_attr( $title ) ), $result );
+}
+
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Filters the given oEmbed HTML.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If the `$url` isn't on the trusted providers list,
</span></span></pre></div>
<a id="trunktestsphpunittestsoembedfilterTitleAttributesphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/oembed/filterTitleAttributes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/oembed/filterTitleAttributes.php (rev 0)
+++ trunk/tests/phpunit/tests/oembed/filterTitleAttributes.php 2019-03-20 17:21:56 UTC (rev 44942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,110 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group oembed
+ */
+class Tests_Filter_oEmbed_Iframe_Title_Attribute extends WP_UnitTestCase {
+ public function data_filter_oembed_iframe_title_attribute() {
+ return array(
+ array(
+ '<p>Foo</p><iframe src=""></iframe><b>Bar</b>',
+ array(
+ 'type' => 'rich',
+ ),
+ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ '<p>Foo</p><iframe src=""></iframe><b>Bar</b>',
+ ),
+ array(
+ '<p>Foo</p><iframe src="" title="Hello World"></iframe><b>Bar</b>',
+ array(
+ 'type' => 'rich',
+ ),
+ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ '<p>Foo</p><iframe title="Hello World" src=""></iframe><b>Bar</b>',
+ ),
+ array(
+ '<p>Foo</p>',
+ array(
+ 'type' => 'rich',
+ 'title' => 'Hello World',
+ ),
+ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ '<p>Foo</p>',
+ ),
+ array(
+ '<p title="Foo">Bar</p>',
+ array(
+ 'type' => 'rich',
+ 'title' => 'Hello World',
+ ),
+ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ '<p title="Foo">Bar</p>',
+ ),
+ array(
+ '<p>Foo</p><iframe src=""></iframe><b>Bar</b>',
+ array(
+ 'type' => 'rich',
+ 'title' => 'Hello World',
+ ),
+ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ '<p>Foo</p><iframe title="Hello World" src=""></iframe><b>Bar</b>',
+ ),
+ array(
+ '<iframe src="" title="Foo"></iframe>',
+ array(
+ 'type' => 'rich',
+ 'title' => 'Bar',
+ ),
+ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+ '<iframe title="Foo" src=""></iframe>',
+ ),
+ );
+ }
+
+ /**
+ * @dataProvider data_filter_oembed_iframe_title_attribute
+ */
+ public function test_oembed_iframe_title_attribute( $html, $oembed_data, $url, $expected ) {
+ $actual = wp_filter_oembed_iframe_title_attribute( $html, (object) $oembed_data, $url );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ public function test_filter_oembed_iframe_title_attribute() {
+ add_filter( 'oembed_iframe_title_attribute', array( $this, '_filter_oembed_iframe_title_attribute' ) );
+
+ $actual = wp_filter_oembed_iframe_title_attribute(
+ '<iframe title="Foo" src=""></iframe>',
+ (object) array(
+ 'type' => 'rich',
+ 'title' => 'Bar',
+ ),
+ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'
+ );
+
+ remove_filter( 'oembed_iframe_title_attribute', array( $this, '_filter_oembed_iframe_title_attribute' ) );
+
+ $this->assertSame( '<iframe title="Baz" src=""></iframe>', $actual );
+ }
+
+ public function test_filter_oembed_iframe_title_attribute_does_not_modify_other_tags() {
+ add_filter( 'oembed_iframe_title_attribute', array( $this, '_filter_oembed_iframe_title_attribute' ) );
+
+ $actual = wp_filter_oembed_iframe_title_attribute(
+ '<p title="Bar">Baz</p><iframe title="Foo" src=""></iframe>',
+ (object) array(
+ 'type' => 'rich',
+ 'title' => 'Bar',
+ ),
+ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'
+ );
+
+ remove_filter( 'oembed_iframe_title_attribute', array( $this, '_filter_oembed_iframe_title_attribute' ) );
+
+ $this->assertSame( '<p title="Bar">Baz</p><iframe title="Baz" src=""></iframe>', $actual );
+ }
+
+ public function _filter_oembed_iframe_title_attribute() {
+ return 'Baz';
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/oembed/filterTitleAttributes.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2019-03-20 15:48:46 UTC (rev 44941)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2019-03-20 17:21:56 UTC (rev 44942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4988,7 +4988,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "thumbnail_width": 480,
</span><span class="cx" style="display: block; padding: 0 10px"> "width": 500,
</span><span class="cx" style="display: block; padding: 0 10px"> "thumbnail_height": 360,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "html": "<iframe width=\"500\" height=\"375\" src=\"https://www.youtube.com/embed/i_cVJgIz_Cs?feature=oembed\" frameborder=\"0\" allowfullscreen></iframe>",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "html": "<iframe title=\"No te olvides de poner el Where en el Delete From. (Una cancion para programadores)\" width=\"500\" height=\"375\" src=\"https://www.youtube.com/embed/i_cVJgIz_Cs?feature=oembed\" frameborder=\"0\" allowfullscreen></iframe>",
</ins><span class="cx" style="display: block; padding: 0 10px"> "author_name": "Jorge Rubira Santos",
</span><span class="cx" style="display: block; padding: 0 10px"> "thumbnail_url": "https://i.ytimg.com/vi/i_cVJgIz_Cs/hqdefault.jpg",
</span><span class="cx" style="display: block; padding: 0 10px"> "title": "No te olvides de poner el Where en el Delete From. (Una cancion para programadores)",
</span></span></pre>
</div>
</div>
</body>
</html>