<!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>[44956] trunk/src/wp-includes/general-template.php: Accessibility: Add ability to pass an ARIA label for the `<form>` element returned by `get_search_form()`.</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/44956">44956</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/44956","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>2019-03-21 09:19:14 +0000 (Thu, 21 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: Add ability to pass an ARIA label for the `<form>` element returned by `get_search_form()`.
This allows screen readers to properly announce each search landmark region independently.
Introduce `search_form_args` filter for the arguments used when generating the search form.
Props afercia, williampatton.
Fixes <a href="https://core.trac.wordpress.org/ticket/42057">#42057</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesgeneraltemplatephp"></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/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php 2019-03-21 05:55:05 UTC (rev 44955)
+++ trunk/src/wp-includes/general-template.php 2019-03-21 09:19:14 UTC (rev 44956)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,11 +175,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * search. To give a few examples of what it can be used for.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.2.0 The $args array parameter was added in place of an $echo boolean flag.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $echo Default to echo and not return the form.
- * @return string|void String when $echo is false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args {
+ * Optional. Array of display arguments.
+ *
+ * @type bool $echo Whether to echo or return the form. Default true.
+ * @type string $aria_label ARIA label for the search form. Useful to distinguish
+ * multiple search forms on the same page and improve
+ * accessibility. Default empty.
+ * }
+ * @return string|void String when the $echo param is false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_search_form( $echo = true ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_search_form( $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires before the search form is retrieved, at the start of get_search_form().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,7 +200,39 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $format = current_theme_supports( 'html5', 'search-form' ) ? 'html5' : 'xhtml';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Back compat: to ensure previous uses of get_search_form continue to
+ * function as expected, we handle a value for the boolean $echo param removed
+ * in 5.2.0. Then we deal with the $args array and cast its defaults.
+ */
+ $echo = true;
+ if ( false === $args ) {
+ $echo = false;
+ }
+
+ if ( ! is_array( $args ) ) {
+ // Set an empty array and allow default arguments to take over.
+ $args = array();
+ }
+
+ // Defaults are to echo and to output no custom label on the form.
+ $defaults = array(
+ 'echo' => $echo,
+ 'aria_label' => '',
+ );
+
+ $args = wp_parse_args( $args, $defaults );
+
</ins><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 array of arguments used when generating the search form.
+ *
+ * @since 5.2.0
+ *
+ * @param array $args The array of arguments for building the search form.
+ */
+ $args = apply_filters( 'search_form_args', $args );
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Filters the HTML format of the search form.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,8 +248,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require( $search_form_template );
</span><span class="cx" style="display: block; padding: 0 10px"> $form = ob_get_clean();
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Build a string containing an aria-label to use for the search form.
+ if ( isset( $args['aria_label'] ) && $args['aria_label'] ) {
+ $aria_label = 'aria-label="' . esc_attr( $args['aria_label'] ) . '" ';
+ } else {
+ /*
+ * If there's no custom aria-label, we can set a default here. At the
+ * moment it's empty as there's uncertainty about what the default should be.
+ */
+ $aria_label = '';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'html5' == $format ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $form = '<form role="search" method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $form = '<form role="search" ' . $aria_label . 'method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">
</ins><span class="cx" style="display: block; padding: 0 10px"> <label>
</span><span class="cx" style="display: block; padding: 0 10px"> <span class="screen-reader-text">' . _x( 'Search for:', 'label' ) . '</span>
</span><span class="cx" style="display: block; padding: 0 10px"> <input type="search" class="search-field" placeholder="' . esc_attr_x( 'Search …', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" />
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -217,7 +267,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <input type="submit" class="search-submit" value="' . esc_attr_x( 'Search', 'submit button' ) . '" />
</span><span class="cx" style="display: block; padding: 0 10px"> </form>';
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $form = '<form role="search" method="get" id="searchform" class="searchform" action="' . esc_url( home_url( '/' ) ) . '">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $form = '<form role="search" ' . $aria_label . 'method="get" id="searchform" class="searchform" action="' . esc_url( home_url( '/' ) ) . '">
</ins><span class="cx" style="display: block; padding: 0 10px"> <div>
</span><span class="cx" style="display: block; padding: 0 10px"> <label class="screen-reader-text" for="s">' . _x( 'Search for:', 'label' ) . '</label>
</span><span class="cx" style="display: block; padding: 0 10px"> <input type="text" value="' . get_search_query() . '" name="s" id="s" />
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -240,7 +290,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $form;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 ( $echo ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $args['echo'] ) && $args['echo'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> echo $result;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> return $result;
</span></span></pre>
</div>
</div>
</body>
</html>