Ticket #27719: 27719.diff

wp-includes/general-template.php

@@ -160 +160 @@
         do_action( 'pre_get_search_form' );
 
         $format = current_theme_supports( 'html5', 'search-form' ) ? 'html5' : 'xhtml';
+        /**
+         * Filter the HTML format of the search form.
+         *
+         * @since 3.6.0
+         *
+         * @param string $format The type of markup - HTML5 or XHTML.
+         */
         $format = apply_filters( 'search_form_format', $format );
 
         $search_form_template = locate_template( 'searchform.php' );
@@ -187 +194 @@
                 }
         }
 
+        /**
+         * Filter the HTML output of the search form.
+         *
+         * @since 2.7.0
+         *
+         * @param string $form The HTML code of the form.
+         */
         $result = apply_filters( 'get_search_form', $form );
         if ( null === $result )
                 $result = $form;
@@ -244 +258 @@
         $logout_url = add_query_arg($args, site_url('wp-login.php', 'login'));
         $logout_url = wp_nonce_url( $logout_url, 'log-out' );
 
+        /**
+         * Filter the Log Out URL of the site.
+         *
+         * @since 2.8.0
+         *
+         * @param string $logout_url    The logout URL.
+         * @param string $redirect      The path to redirect to on logout if supplied.
+         */
         return apply_filters('logout_url', $logout_url, $redirect);
 }
 
@@ -269 +291 @@
         if ( $force_reauth )
                 $login_url = add_query_arg('reauth', '1', $login_url);
 
+        /**
+         * Filter the login URL.
+         *
+         * @since 2.8.0
+         *
+         * @param string $login_url     The login URL.
+         * @param string $redirect      The path to redirect to on login if supplied.
+         */
         return apply_filters('login_url', $login_url, $redirect);
 }
 
@@ -284 +314 @@
  * @return string
  */
 function wp_registration_url() {
+        /**
+         * Filter the user registration URL.
+         *
+         * @since 3.6.0
+         *
+         * @param string The user registration URL returned by the site_url() function.
+         */
         return apply_filters( 'register_url', site_url( 'wp-login.php?action=register', 'login' ) );
 }
 
@@ -312 +349 @@
                 'value_username' => '',
                 'value_remember' => false, // Set this to true to default the "Remember me" checkbox to checked
         );
+        /**
+         * Filter the default arguments of the wp_login_form() function.
+         *
+         * @since 3.0.0
+         *
+         * @param array $defaults The default arguments of the login form.
+         */
         $args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );
 
         $form = '
@@ -359 +403 @@
         }
 
         $lostpassword_url = add_query_arg( $args, network_site_url('wp-login.php', 'login') );
+        /**
+         * Filter the lost password URL.
+         *
+         * @since 2.8.0
+         *
+         * @param string $lostpassword_url      The URL of the lost password page.
+         * @param string $redirect              The path to redirect to on login.
+         */
         return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect );
 }
 
@@ -387 +439 @@
                 $link = $before . '<a href="' . admin_url() . '">' . __('Site Admin') . '</a>' . $after;
         }
 
+        /**
+         * Filter the HTML link to the registration or admin page.
+         *
+         * @since 1.5.2
+         *
+         * @param string $link The HTML code of the link to the registration or admin page
+         */
         if ( $echo )
                 echo apply_filters('register', $link);
         else
@@ -654 +713 @@
                 $title = $prefix . implode( " $sep ", $title_array );
         }
 
+        /**
+         * Filter the string to be displayed between the <title> tags.
+         *
+         * @since 2.0.0
+         *
+         * @param string $title         The page title of the current blog area.
+         * @param string $sep           The separator of the title.
+         * @param string $seplocation   The location of the separator right or left.
+         */
         $title = apply_filters('wp_title', $title, $sep, $seplocation);
 
         // Send it out
@@ -686 +754 @@
         if ( !isset($_post->post_title) )
                 return;
 
+        /**
+         * Filter the single post page title.
+         *
+         * @since 1.2.1
+         *
+         * @param string $_post->post_title     The single post page title.
+         * @param object $_post                 The current queried object as returned by get_queried_object().
+         */
         $title = apply_filters('single_post_title', $_post->post_title, $_post);
         if ( $display )
                 echo $prefix . $title;