Changeset 45377

Timestamp:

05/22/2019 09:47:49 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for the_date() and the_weekday_date().

Correct type for $currentday and $previousday globals.

See #47354, #47110.

Location:

trunk/src/wp-includes

Files:

• class-wp-query.php (modified) (1 diff)
• general-template.php (modified) (4 diffs)

trunk/src/wp-includes/class-wp-query.php

@@ -4170 +4170 @@
      * @since 4.4.0 Added the ability to pass a post ID to `$post`.
      *
-     * @global int             $id
-     * @global WP_User         $authordata
-     * @global string|int|bool $currentday
-     * @global string|int|bool $currentmonth
-     * @global int             $page
-     * @global array           $pages
-     * @global int             $multipage
-     * @global int             $more
-     * @global int             $numpages
+     * @global int     $id
+     * @global WP_User $authordata
+     * @global string  $currentday
+     * @global string  $currentmonth
+     * @global int     $page
+     * @global array   $pages
+     * @global int     $multipage
+     * @global int     $more
+     * @global int     $numpages
      *
      * @param WP_Post|object|int $post WP_Post instance or Post ID/object.

trunk/src/wp-includes/general-template.php

@@ -2329 +2329 @@
  * @since 0.71
  *
- * @global string|int|bool $currentday
- * @global string|int|bool $previousday
+ * @global string $currentday  The day of the current post in the loop.
+ * @global string $previousday The day of the previous post in the loop.
  *
  * @param string $d      Optional. PHP date format defaults to the date_format option if not specified.
@@ -2676 +2676 @@
  * @since 0.71
  *
- * @global WP_Locale $wp_locale
+ * @global WP_Locale $wp_locale The WordPress date and time locale object.
  */
 function the_weekday() {
     global $wp_locale;
+
     $the_weekday = $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
 
@@ -2700 +2701 @@
  * @since 0.71
  *
- * @global WP_Locale       $wp_locale
- * @global string|int|bool $currentday
- * @global string|int|bool $previousweekday
- *
- * @param string $before Optional Output before the date.
- * @param string $after Optional Output after the date.
+ * @global WP_Locale $wp_locale       The WordPress date and time locale object.
+ * @global string    $currentday      The day of the current post in the loop.
+ * @global string    $previousweekday The day of the previous post in the loop.
+ *
+ * @param string $before Optional. Output before the date.
+ * @param string $after  Optional. Output after the date.
  */
 function the_weekday_date( $before = '', $after = '' ) {
@@ -2722 +2723 @@
      * @since 0.71
      *
-     * @param string $the_weekday_date
+     * @param string $the_weekday_date The weekday on which the post was written.
      * @param string $before           The HTML to output before the date.
      * @param string $after            The HTML to output after the date.