get_the_time( string $format = '', int|WP_Post $post = null ): string|int|false
Retrieves the time at which the post was written.
Parameters
-
$formatstring Optional -
Format to use for retrieving the time the post was written. Accepts
'G','U', or PHP date format.
Defaults to the'time_format'option.Default:
'' -
$postint|WP_Post Optional -
Post ID or post object. Default is global
$postobject.Default:
null
Return
string|int|false Formatted date string or Unix timestamp if $format is 'U' or 'G'.
False on failure.
Source
File: wp-includes/general-template.php.
View all references
function get_the_time( $format = '', $post = null ) {
$post = get_post( $post );
if ( ! $post ) {
return false;
}
$_format = ! empty( $format ) ? $format : get_option( 'time_format' );
$the_time = get_post_time( $_format, false, $post, true );
/**
* Filters the time a post was written.
*
* @since 1.5.0
*
* @param string|int $the_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 WP_Post $post Post object.
*/
return apply_filters( 'get_the_time', $the_time, $format, $post );
}
Hooks
-
apply_filters( 'get_the_time',
string|int $the_time ,string $format ,WP_Post $post ) -
Filters the time a post was written.
Changelog
| Version | Description |
|---|---|
| 1.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Basic Example
Returns the time of the current post using the WordPress default format, and displays it using the PHP echo command.
Returns the time of the post with ID $post->ID in the WordPress default format.
Getting Unix Timestamp
Assigns the local time of the current post in seconds (since January 1 1970, known as the Unix Epoch) to the variable $u_time.
In most cases, you would probably want the epoch time for GMT (rather than for the local time zone), which you can get with the get_post_time() function, setting the $gmt option to true: