Ticket #27719: 27719.3.diff

wp-includes/general-template.php

@@ -1520 +1520 @@
                 $the_time = get_post_time(get_option('time_format'), false, $post, true);
         else
                 $the_time = get_post_time($d, false, $post, true);
+        /**
+         * Filter the date string returned by get_the_time() function.
+         *
+         * @since 1.5.2
+         *
+         * @param string $the_time The formatted time returned by get_the_time() function.
+         * @param string $d        The date and time format.
+         * @param object $post     The WP_Post object.
+         */
         return apply_filters('get_the_time', $the_time, $d, $post);
 }
 
@@ -1544 +1553 @@
                 $time = $post->post_date;
 
         $time = mysql2date($d, $time, $translate);
+        /**
+         * Filter the formatted date string returned by get_post_time() function.
+         *
+         * @since 2.6.0
+         *
+         * @param string  $time The formatted date string.
+         * @param string  $d    The date and time format.
+         * @param boolean $gmt  Whether to retrieve the GMT time.
+         */
         return apply_filters('get_post_time', $time, $d, $gmt);
 }
 
@@ -1555 +1573 @@
  * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
  */
 function the_modified_time($d = '') {
+        /**
+         * Filter the time string returned by the_modified_time() function.
+         *
+         * @since 2.0.0
+         *
+         * @param string $modified_time Time and date returned by the_modified_time() function.
+         * @param string $d             The date and time format.
+         */
         echo apply_filters('the_modified_time', get_the_modified_time($d), $d);
 }
 
@@ -1571 +1597 @@
                 $the_time = get_post_modified_time(get_option('time_format'), null, null, true);
         else
                 $the_time = get_post_modified_time($d, null, null, true);
+        /**
+         * Filter the time string returned by the get_the_modified_time() function.
+         *
+         * @since 2.0.0
+         *
+         * @param string $the_time The time returned by the get_the_modified_time() function.
+         * @param string $d        The time and date format.
+         */
         return apply_filters('get_the_modified_time', $the_time, $d);
 }
 
@@ -1594 +1628 @@
                 $time = $post->post_modified;
         $time = mysql2date($d, $time, $translate);
 
+        /**
+         * Filter the time string returned by the get_post_modified_time() function.
+         *
+         * @since 2.8.0
+         *
+         * @param string  $time Formatted time returned by the get_post_modified_time() function.
+         * @param string  $d    The date and time format.
+         * @param boolean $gmt  Whether to return the GMT time.
+         */
         return apply_filters('get_post_modified_time', $time, $d, $gmt);
 }
 
@@ -1607 +1650 @@
 function the_weekday() {
         global $wp_locale;
         $the_weekday = $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
+        /**
+         * Filter the weekday string echoed by the the_weekday() function.
+         *
+         * @since 1.2.1
+         *
+         * @param string $the_weekday The weekday echoed by the the_weekday() function.
+         */
         $the_weekday = apply_filters('the_weekday', $the_weekday);
         echo $the_weekday;
 }
@@ -1631 +1681 @@
                 $the_weekday_date .= $after;
                 $previousweekday = $currentday;
         }
+        /**
+         * Filter the weekday date HTML code echoed by the the_weekday_date() function.
+         *
+         * @since 1.2.1
+         *
+         * @param string $the_weekday_date The weekday date prepended and appended with $before and $after.
+         * @param string $before           Output before the date.
+         * @param string $after            Output after the date.
+         */
         $the_weekday_date = apply_filters('the_weekday_date', $the_weekday_date, $before, $after);
         echo $the_weekday_date;
 }
@@ -1832 +1891 @@
                 }
         }
 
+        /**
+         * Filter the boolean returned by user_can_richedit() function on whether the user should have a WYSIWIG editor.
+         *
+         * @since 2.1.0
+         *
+         * @param boolean $wp_rich_edit Whether the user should have a WYSIWYG editor.
+         */
         return apply_filters('user_can_richedit', $wp_rich_edit);
 }
 
@@ -1851 +1917 @@
                 $ed = get_user_setting('editor', 'tinymce');
                 $r = ( in_array($ed, array('tinymce', 'html', 'test') ) ) ? $ed : $r;
         }
+        /**
+         * Filter the default editor string returned by wp_default_editor() function.
+         *
+         * @since 2.5.0
+         *
+         * @param string $r The default editor.
+         */
         return apply_filters( 'wp_default_editor', $r ); // filter
 }
 
@@ -1894 +1967 @@
  * @return string
  */
 function get_search_query( $escaped = true ) {
+        /**
+         * Filter the search query  returned by get_search_query() function.
+         *
+         * @since 2.3.0
+         *
+         * @param string $search_query The search WordPress query variable.
+         */
         $query = apply_filters( 'get_search_query', get_query_var( 's' ) );
         if ( $escaped )
                 $query = esc_attr( $query );
@@ -1910 +1990 @@
  * @since 2.1.0
  */
 function the_search_query() {
+        /**
+         * Filter the search query echoed by the the_search_query() function.
+         *
+         * @since 2.3.0
+         *
+         * @param string $search_query Non-escaped search query.
+         */
         echo esc_attr( apply_filters( 'the_search_query', get_search_query( false ) ) );
 }
 
@@ -1939 +2026 @@
         }
 
         $output = implode(' ', $attributes);
+        /**
+         * Filter the HTML language attributes string returned by the language_attributes() function.
+         *
+         * @since 2.5.0
+         *
+         * @param string $output The type of html document - xhtml or html.
+         */
         $output = apply_filters('language_attributes', $output);
         echo $output;
 }
@@ -2191 +2285 @@
         }
         $_file = add_query_arg( 'version', get_bloginfo( 'version' ),  $_file );
 
+        /**
+         * Filter the URL of WordPress admin CSS file returned by the wp_admin_css_uri() function.
+         *
+         * @since 2.3.0
+         *
+         * @param string $_file The URL of a WordPress admin CSS file.
+         * @param string $file  File relative to wp-admin without the ".css" extension.
+         */
         return apply_filters( 'wp_admin_css_uri', $_file, $file );
 }
 
@@ -2259 +2361 @@
  * @since 2.5.0
  */
 function wp_generator() {
+        /**
+         * Filter the markup type of the HTML meta generator tag.
+         *
+         * @since 2.5.0
+         *
+         * @param string $type The type of HTML markup.
+         */
         the_generator( apply_filters( 'wp_generator_type', 'xhtml' ) );
 }
 
@@ -2274 +2383 @@
  * @param string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export).
  */
 function the_generator( $type ) {
+        /**
+         * Filter the HTML meta generator tag echoed by the the_generator() function.
+         *
+         * @since 2.5.0
+         *
+         * @param string $generator The HTML code of the generator meta tag.
+         * @param string $type      The type of generator to output.
+         */
         echo apply_filters('the_generator', get_the_generator($type), $type) . "\n";
 }
 
@@ -2340 +2457 @@
                         $gen = '<!-- generator="WordPress/' . get_bloginfo_rss('version') . '" created="'. date('Y-m-d H:i') . '" -->';
                         break;
         }
+        /**
+         * Filter the HTML meta generator string returned by the get_the_generator_$type function.
+         *
+         * @since 2.5.0
+         *
+         * @param string $gen  The HTML generator meta tag.
+         * @param string $type The type of generator to output.
+         */
         return apply_filters( "get_the_generator_{$type}", $gen, $type );
 }