WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_comment_time()

get_comment_time( string $format = '', bool $gmt = false, bool $translate = true, int|WP_Comment $comment_id ): string

In this article

Back to top

Retrieves the comment time of the current comment.

Parameters

$formatstringoptional
PHP date format. Defaults to the 'time_format' option.

Default:''

$gmtbooloptional
Whether to use the GMT date.

Default:false

$translatebooloptional
Whether to translate the time (for use in feeds).

Default:true

$comment_idint|WP_Commentoptional
WP_Comment or ID of the comment for which to get the time.
Default current comment.

Return

string The formatted time.

Source

function get_comment_time( $format = '', $gmt = false, $translate = true, $comment_id = 0 ) {
	$comment = get_comment( $comment_id );

	if ( null === $comment ) {
		return '';
	}

	$comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;

	$_format = ! empty( $format ) ? $format : get_option( 'time_format' );

	$comment_time = mysql2date( $_format, $comment_date, $translate );

	/**
	 * Filters the returned comment time.
	 *
	 * @since 1.5.0
	 *
	 * @param string|int $comment_time The comment time, formatted as a date string or Unix timestamp.
	 * @param string     $format       PHP date format.
	 * @param bool       $gmt          Whether the GMT date is in use.
	 * @param bool       $translate    Whether the time is translated.
	 * @param WP_Comment $comment      The comment object.
	 */
	return apply_filters( 'get_comment_time', $comment_time, $format, $gmt, $translate, $comment );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_comment_time’, string|int $comment_time, string $format, bool $gmt, bool $translate, WP_Comment $comment )

Filters the returned comment time.

UsesDescription
mysql2date()wp-includes/functions.php

Converts given MySQL date string into a different format.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

get_option()wp-includes/option.php

Retrieves an option value based on an option name.

get_comment()wp-includes/comment.php

Retrieves comment data given a comment ID or comment object.

Show 2 moreShow less
Used byDescription
Walker_Comment::comment()wp-includes/class-walker-comment.php

Outputs a single comment.

Walker_Comment::html5_comment()wp-includes/class-walker-comment.php

Outputs a comment in the HTML5 format.

comment_time()wp-includes/comment-template.php

Displays the comment time of the current comment.

Changelog

VersionDescription
6.2.0Added the $comment_id parameter.
1.5.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Rose
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Examples of Different Time Formats

    // Prints something like: 03:08:46 PM
echo get_comment_time( 'h:i:s A' );

// Prints something like: 3:08:46 pm
echo get_comment_time( 'g:i:s a' );

// Prints 24 hour time, something like: 0800
echo get_comment_time( 'Hi' );

// Prints 24 hour time, something like: 800
echo get_comment_time( 'Gi' );

You must log in before being able to contribute a note or feedback.