the_date( string $format = '', string $before = '', string $after = '', bool $echo = true )

Display or Retrieve the date the current post was written (once per date)

Contents

Description Description

Will only output the date if the current post’s date is different from the previous one output.

i.e. Only one date listing will show per day worth of posts shown in the loop, even if the function is called several times for each post.

HTML output can be filtered with ‘the_date’. Date string output can be filtered with ‘get_the_date’.

Top ↑

Parameters Parameters

$format

(string) (Optional) PHP date format defaults to the date_format option if not specified.

Default value: ''

$before

(string) (Optional) Output before the date.

Default value: ''

$after

(string) (Optional) Output after the date.

Default value: ''

$echo

(bool) (Optional) default is display. Whether to echo the date or return it.

Default value: true

Top ↑

Return Return

(string|void) String if retrieving.

Top ↑

Source Source

File: wp-includes/general-template.php 

function the_date( $format = '', $before = '', $after = '', $echo = true ) {
	global $currentday, $previousday;

	$the_date = '';

	if ( is_new_day() ) {
		$the_date    = $before . get_the_date( $format ) . $after;
		$previousday = $currentday;
	}

	/**
	 * Filters the date a post was published for display.
	 *
	 * @since 0.71
	 *
	 * @param string $the_date The formatted date string.
	 * @param string $format   PHP date format. Defaults to 'date_format' option
	 *                         if not specified.
	 * @param string $before   HTML output before the date.
	 * @param string $after    HTML output after the date.
	 */
	$the_date = apply_filters( 'the_date', $the_date, $format, $before, $after );

	if ( $echo ) {
		echo $the_date;
	} else {
		return $the_date;
	}
}

Expand full source code Collapse full source code View on Trac

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/general-template.php: get_the_date()

Retrieve the date on which the post was written.
wp-includes/general-template.php: the_date

Filters the date a post was published for display.
wp-includes/functions.php: is_new_day()

Determines whether the publish date of the current post in the loop is different from the publish date of the previous post in the loop.
wp-includes/plugin.php: apply_filters()

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

Top ↑

Changelog Changelog

Changelog
Version Description
0.71 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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