get_the_date( string $format = '', int|WP_Post $post = null ): string|int|false

Retrieves the date on which the post was written.


Description

Unlike the_date() this function will always return the date.
Modify output with the ‘get_the_date’ filter.


Top ↑

Parameters

$format string Optional
PHP date format. Defaults to the 'date_format' option.

Default: ''

$post int|WP_Post Optional
Post ID or WP_Post object. Default current post.

Default: null


Top ↑

Return

string|int|false Date the current post was written. False on failure.


Top ↑

Source

File: wp-includes/general-template.php. View all references

function get_the_date( $format = '', $post = null ) {
	$post = get_post( $post );

	if ( ! $post ) {
		return false;
	}

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

	$the_date = get_post_time( $_format, false, $post, true );

	/**
	 * Filters the date a post was published.
	 *
	 * @since 3.0.0
	 *
	 * @param string|int  $the_date Formatted date string or Unix timestamp if `$format` is 'U' or 'G'.
	 * @param string      $format   PHP date format.
	 * @param WP_Post     $post     The post object.
	 */
	return apply_filters( 'get_the_date', $the_date, $format, $post );
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes

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