W3cubDocs

/WordPress

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

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 );
}

Hooks

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

Filters the returned comment time.

Changelog

Version Description
6.2.0 Added the $comment_id parameter.
1.5.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_comment_time