Changeset 53000

Timestamp:

03/28/2022 10:23:03 AM (3 years ago)

Author:

johnbillion

Message:

Docs: Correct the documented return types for date and time related functions and filters.

See #54729

File:

• trunk/src/wp-includes/general-template.php (modified) (4 diffs)

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

@@ -2556 +2556 @@
  * @param string      $format Optional. PHP date format. Defaults to the 'date_format' option.
  * @param int|WP_Post $post   Optional. Post ID or WP_Post object. Default current post.
- * @return string|false Date the current post was written. False on failure.
+ * @return string|int|false Date the current post was written. False on failure.
  */
 function get_the_date( $format = '', $post = null ) {
@@ -2574 +2574 @@
      * @since 3.0.0
      *
-     * @param string      $the_date The formatted date.
+     * @param string|int  $the_date Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.
      * @param string      $format   PHP date format.
-     * @param int|WP_Post $post     The post object or ID.
+     * @param WP_Post     $post     The post object.
      */
     return apply_filters( 'get_the_date', $the_date, $format, $post );
@@ -2700 +2700 @@
      * @since 1.5.0
      *
-     * @param string      $the_time The formatted time.
+     * @param string|int  $the_time Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.
      * @param string      $format   Format to use for retrieving the time the post
      *                              was written. Accepts 'G', 'U', or PHP date format.
-     * @param int|WP_Post $post     WP_Post object or ID.
+     * @param WP_Post     $post     Post object.
      */
     return apply_filters( 'get_the_time', $the_time, $format, $post );
@@ -2757 +2757 @@
      * @since 2.6.0
      *
-     * @param string $time   The formatted time.
-     * @param string $format Format to use for retrieving the time the post was written.
-     *                       Accepts 'G', 'U', or PHP date format. Default 'U'.
-     * @param bool   $gmt    Whether to retrieve the GMT time. Default false.
+     * @param string|int $time   Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.
+     * @param string     $format Format to use for retrieving the time the post was written.
+     *                           Accepts 'G', 'U', or PHP date format.
+     * @param bool       $gmt    Whether to retrieve the GMT time.
      */
     return apply_filters( 'get_post_time', $time, $format, $gmt );