get_post_time( string $format = ‘U’, bool $gmt = false, int|WP_Post $post = null, bool $translate = false ): string|int|false

Retrieves the time at which the post was written.

Parameters

$formatstringoptional
Format to use for retrieving the time the post was written. Accepts 'G', 'U', or PHP date format. Default 'U'.

Default:'U'

$gmtbooloptional
Whether to retrieve the GMT time.

Default:false

$postint|WP_Postoptional
Post ID or post object. Default is global $post object.

Default:null

$translatebooloptional
Whether to translate the time string.

Default:false

Return

string|int|false Formatted date string or Unix timestamp if $format is 'U' or 'G'.
False on failure.

Source

function get_post_time( $format = 'U', $gmt = false, $post = null, $translate = false ) {
	$post = get_post( $post );

	if ( ! $post ) {
		return false;
	}

	$source   = ( $gmt ) ? 'gmt' : 'local';
	$datetime = get_post_datetime( $post, 'date', $source );

	if ( false === $datetime ) {
		return false;
	}

	if ( 'U' === $format || 'G' === $format ) {
		$time = $datetime->getTimestamp();

		// Returns a sum of timestamp with timezone offset. Ideally should never be used.
		if ( ! $gmt ) {
			$time += $datetime->getOffset();
		}
	} elseif ( $translate ) {
		$time = wp_date( $format, $datetime->getTimestamp(), $gmt ? new DateTimeZone( 'UTC' ) : null );
	} else {
		if ( $gmt ) {
			$datetime = $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
		}

		$time = $datetime->format( $format );
	}

	/**
	 * Filters the localized time a post was written.
	 *
	 * @since 2.6.0
	 *
	 * @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 );
}

Hooks

apply_filters( ‘get_post_time’, string|int $time, string $format, bool $gmt )

Filters the localized time a post was written.

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

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