Changeset 55287

Timestamp:

02/07/2023 06:24:02 PM (15 months ago)

Author:

SergeyBiryukov

Message:

Comments: Allow to pass $comment_ID parameter to comment_time().

This brings consistency with:

• get_comment_time()
• get_comment_date()
• comment_date()

Includes:

• Correcting the @since tag for get_comment_time().
• Synchronizing parameter description between get_comment_date() and get_comment_time().

Follow-up to [55284].

See #52322.

File:

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

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

@@ -548 +548 @@
  *
  * @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.
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the date.
  *                                   Default current comment.
  * @return string The comment's date.
@@ -1032 +1032 @@
  *
  * @since 1.5.0
- * @since 6.2.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ * @since 6.2.0 Added the `$comment_ID` parameter.
  *
  * @param string         $format     Optional. PHP date format. Defaults to the 'time_format' option.
@@ -1038 +1038 @@
  * @param bool           $translate  Optional. Whether to translate the time (for use in feeds).
  *                                   Default true.
- * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the date.
- *                                   Default is 0, or the global comment.
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the time.
+ *                                   Default current comment.
  * @return string The formatted time.
  */
@@ -1073 +1073 @@
  *
  * @since 0.71
- *
- * @param string $format Optional. PHP time format. Defaults to the 'time_format' option.
- */
-function comment_time( $format = '' ) {
-    echo get_comment_time( $format );
+ * @since 6.2.0 Added the `$comment_ID` parameter.
+ *
+ * @param string         $format     Optional. PHP time format. Defaults to the 'time_format' option.
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the time.
+ *                                   Default current comment.
+ */
+function comment_time( $format = '', $comment_ID = 0 ) {
+    echo get_comment_time( $format, $comment_ID );
 }