Ticket #42057: 42057.diff

wp-includes/general-template.php

@@ -174 +174 @@
  *
  * @since 2.7.0
  *
- * @param bool $echo Default to echo and not return the form.
- * @return string|void String when $echo is false.
+ * @param array $args Default args are to echo and include no custom label.
+ * @return string|void String when $args['echo'] is false.
  */
-function get_search_form( $echo = true ) {
+function get_search_form( $args = array() ) {
         /**
          * Fires before the search form is retrieved, at the start of get_search_form().
          *
@@ -200 +200 @@
          */
         $format = apply_filters( 'search_form_format', $format );
 
+        /*
+         Back compat: to ensure previous uses of get_search_form continue to
+         function as expected first check if we have an array. If not treat as
+         booleen - and if it's not explicitly FALSE then assume we want to echo.
+         */
+        if( ! is_array( $args ) && ! false === $args ){
+                // we can set an empty array and allow default args to take over.
+                $args = array();
+        }
+
+        // defaults are to echo and to output no custom label on the landmark.
+        $defaults = array(
+                'echo'  => true,
+                'label' => false,
+        );
+
+        // merge any args with the defaults.
+        $args = wp_parse_args( $args, $defaults );
+
+        /**
+         * Filters the array of args used when generating the search form.
+         *
+         * @since NEW
+         *
+         * @param array $args The array of args used when building the search form.
+         */
+        $result = apply_filters( 'search_form_args', $args );
+
         $search_form_template = locate_template( 'searchform.php' );
         if ( '' != $search_form_template ) {
                 ob_start();
                 require( $search_form_template );
                 $form = ob_get_clean();
         } else {
+                // form a string containaing a label to use for the search role.
+                if( $args['label'] ){
+                        $label = 'aria-label="' . esc_attr( $args['label'] ) . '" ';
+                } else {
+                        // if there is no custom label we can set a default here. ATM it is
+                        // empty as there's uncertainty about what the default should be.
+                        $label = '';
+                }
                 if ( 'html5' == $format ) {
-                        $form = '<form role="search" method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">
+                        $form = '<form role="search" ' . $label . 'method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">
                                 <label>
                                         <span class="screen-reader-text">' . _x( 'Search for:', 'label' ) . '</span>
                                         <input type="search" class="search-field" placeholder="' . esc_attr_x( 'Search &hellip;', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" />
@@ -215 +251 @@
                                 <input type="submit" class="search-submit" value="'. esc_attr_x( 'Search', 'submit button' ) .'" />
                         </form>';
                 } else {
-                        $form = '<form role="search" method="get" id="searchform" class="searchform" action="' . esc_url( home_url( '/' ) ) . '">
+                        $form = '<form role="search" ' . $label . 'method="get" id="searchform" class="searchform" action="' . esc_url( home_url( '/' ) ) . '">
                                 <div>
                                         <label class="screen-reader-text" for="s">' . _x( 'Search for:', 'label' ) . '</label>
                                         <input type="text" value="' . get_search_query() . '" name="s" id="s" />
@@ -237 +273 @@
         if ( null === $result )
                 $result = $form;
 
-        if ( $echo )
+        if ( array_key_exists( 'echo', $args ) && $args['echo'] )
                 echo $result;
         else
                 return $result;