Changeset 48929 for trunk/src/wp-includes/comment-template.php

Timestamp:

09/01/2020 12:41:19 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize the description of the $format parameter in various date/time functions for posts and comments.

See #50768.

File:

• trunk/src/wp-includes/comment-template.php (modified) (6 diffs)

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

@@ -545 +545 @@
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param string         $format     Optional. The format of the date. Default user's setting.
+ * @param string         $format     Optional. PHP date format. Defaults to the 'date_format' option.
  * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the date.
  *                                   Default current comment.
@@ -563 +563 @@
      *
      * @param string|int $date    Formatted date string or Unix timestamp.
-     * @param string     $format  The format of the date.
+     * @param string     $format  PHP date format.
      * @param WP_Comment $comment The comment object.
      */
@@ -575 +575 @@
  * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
  *
- * @param string         $format     Optional. The format of the date. Default user's settings.
+ * @param string         $format     Optional. PHP date format. Defaults to the 'date_format' option.
  * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the date.
  *                                   Default current comment.
@@ -1034 +1034 @@
  * @since 1.5.0
  *
- * @param string $format    Optional. The format of the time. Default user's settings.
+ * @param string $format    Optional. PHP date format. Defaults to the 'time_format' option.
  * @param bool   $gmt       Optional. Whether to use the GMT date. Default false.
  * @param bool   $translate Optional. Whether to translate the time (for use in feeds).
@@ -1055 +1055 @@
      *
      * @param string|int $date      The comment time, formatted as a date string or Unix timestamp.
-     * @param string     $format    Date format.
+     * @param string     $format    PHP date format.
      * @param bool       $gmt       Whether the GMT date is in use.
      * @param bool       $translate Whether the time is translated.
@@ -1068 +1068 @@
  * @since 0.71
  *
- * @param string $format Optional. The format of the time. Default user's settings.
+ * @param string $format Optional. PHP date format. Defaults to the 'time_format' option.
  */
 function comment_time( $format = '' ) {