Ticket #27719: 27719.2.diff

wp-includes/general-template.php

@@ -216 +216 @@
         else
                 $link = '<a href="' . esc_url( wp_logout_url($redirect) ) . '">' . __('Log out') . '</a>';
 
-        if ( $echo )
+        if ( $echo ) {
+                /**
+                 * Filter the HTML Log In/Out link.
+                 *
+                 * @since 1.5.2
+                 *
+                 * @param string $link HTML link content for Log In/Out.
+                 */
                 echo apply_filters('loginout', $link);
-        else
+        }
+        else {
+                /** This filter is documented in wp-includes/general-template.php */
                 return apply_filters('loginout', $link);
+        }
 }
 
 /**
@@ -529 +539 @@
                 $url = false;
 
         if ( 'display' == $filter ) {
-                if ( $url )
+                if ( $url ) {
+                        /**
+                         * Filter the URL returned by get_bloginfo().
+                         *
+                         * @since 2.0.11
+                         *
+                         * @param string $output The URL returned by bloginfo().
+                         * @param string $show   The keyword naming the information requested.
+                         */
                         $output = apply_filters('bloginfo_url', $output, $show);
-                else
+                }
+                else {
+                        /**
+                         *  Filter the information returned by get_bloginfo().
+                         *
+                         * @since 1.2.1
+                         *
+                         * @param string $output The non-URL information mentioned in $show.
+                         * @param string $show   The keyword naming the information requested.
+                         */
                         $output = apply_filters('bloginfo', $output, $show);
+                }
         }
 
         return $output;
@@ -795 +823 @@
         if ( !$term )
                 return;
 
-        if ( is_category() )
+        if ( is_category() ) {
+                /**
+                 * Filter the page title for category archive.
+                 *
+                 * @since 2.0.11
+                 *
+                 * @param string $term_name Name of the category whose archive is being displayed
+                 */
                 $term_name = apply_filters( 'single_cat_title', $term->name );
-        elseif ( is_tag() )
+        }
+        elseif ( is_tag() ) {
+                /**
+                 * Filter the page title for tag archive.
+                 *
+                 * @since 2.3
+                 *
+                 * @param string $term_name Name of the category whose archive is being displayed
+                 */
                 $term_name = apply_filters( 'single_tag_title', $term->name );
-        elseif ( is_tax() )
+        }
+        elseif ( is_tax() ) {
+                /**
+                 * Filter the page title for custom taxonomy archive page.
+                 *
+                 * @since 3.1
+                 *
+                 * @param string $term_name Name of the category whose archive is being displayed
+                 */
                 $term_name = apply_filters( 'single_term_title', $term->name );
+        }
         else
                 return;
 
@@ -902 +954 @@
         else // custom
                 $link_html = "\t$before<a href='$url'>$text</a>$after\n";
 
+        /**
+         * Filter the HTML link content for archive.
+         *
+         * @since 2.6
+         *
+         * @param string HTML link content for archive.
+         */
         $link_html = apply_filters( 'get_archives_link', $link_html );
 
         return $link_html;
@@ -978 +1037 @@
                 $archive_week_end_date_format = get_option('date_format');
         }
 
+        /**
+         * Filter the SQL WHERE clause for retrieving archives.
+         *
+         * @since 2.2
+         *
+         * @param string $sql_where Portion of SQL query containing WHERE clause.
+         * @param array  $r         The arguments of the wp_get_archives() function.
+         */
         $where = apply_filters( 'getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r );
         $join = apply_filters( 'getarchives_join', '', $r );
 
@@ -1137 +1204 @@
         if ( $cache = wp_cache_get( 'get_calendar', 'calendar' ) ) {
                 if ( is_array($cache) && isset( $cache[ $key ] ) ) {
                         if ( $echo ) {
+                                /**
+                                 * Filter the HTML output of the get_calender_function.
+                                 *
+                                 * @since 3.0
+                                 *
+                                 * @param string $cache_key HTML output of the calendar.
+                                 */
                                 echo apply_filters( 'get_calendar',  $cache[$key] );
                                 return;
                         } else {
+                                /** This filter is documented in wp-includes/general-template.php */
                                 return apply_filters( 'get_calendar',  $cache[$key] );
                         }
                 }
@@ -1408 +1483 @@
                 $the_date = $before . get_the_date( $d ) . $after;
                 $previousday = $currentday;
 
+                /**
+                 * Filter the date returned by the the_date() function.
+                 *
+                 * @since 1.2.1
+                 *
+                 * @param string $the_date The formatted date string.
+                 * @param string $d        PHP date format.
+                 * @param string $before   Output before the date.
+                 * @param string $after    Output after the date.
+                 */
                 $the_date = apply_filters( 'the_date', $the_date, $d, $before, $after );
 
                 if ( $echo )
@@ -1466 +1551 @@
 function the_modified_date($d = '', $before='', $after='', $echo = true) {
 
         $the_modified_date = $before . get_the_modified_date($d) . $after;
+        /**
+         * Filter the date on returned by the the_modified_date() function.
+         *
+         * @since 2.1.0
+         *
+         * @param string $the_modified_date The formatted date.
+         * @param string $d                 PHP date format.
+         * @param string $before            Output before the date.
+         * @param string $after             Output after the date.
+         */
         $the_modified_date = apply_filters('the_modified_date', $the_modified_date, $d, $before, $after);
 
         if ( $echo )
@@ -1488 +1583 @@
                 $the_time = get_post_modified_time(get_option('date_format'), null, null, true);
         else
                 $the_time = get_post_modified_time($d, null, null, true);
+        /**
+         * Filter the date returned by the get_the_modified_date() function.
+         *
+         * @since 2.1.0
+         *
+         * @param string $the_time The formatted date.
+         * @param string $d        PHP date formate.
+         */
         return apply_filters('get_the_modified_date', $the_time, $d);
 }
 
@@ -1499 +1602 @@
  * @param string $d Either 'G', 'U', or php date format.
  */
 function the_time( $d = '' ) {
+        /**
+         * Filter the time returned by the the_time() function.
+         *
+         * @since 1.2.1
+         *
+         * @param string $get_the_time The formatted date.
+         * @param string $d            PHP date format.
+         */
         echo apply_filters('the_time', get_the_time( $d ), $d);
 }