wp_date() – Function | Developer.WordPress.org

Retrieves the date, in localized format.

Description

This is a newer function, intended to replace date_i18n() without legacy quirks in it.

Note that, unlike date_i18n(), this function accepts a true Unix timestamp, not summed with timezone offset.

Parameters

$formatstringrequired: PHP date format.
$timestampintoptional: Unix timestamp. Defaults to current time.
Default:null
$timezoneDateTimeZoneoptional: Timezone to output result in. Defaults to timezone from site settings.
Default:null

Return

string|false The date, translated if locale specifies it. False on invalid timestamp input.

Source

function wp_date( $format, $timestamp = null, $timezone = null ) {
	global $wp_locale;

	if ( null === $timestamp ) {
		$timestamp = time();
	} elseif ( ! is_numeric( $timestamp ) ) {
		return false;
	}

	if ( ! $timezone ) {
		$timezone = wp_timezone();
	}

	$datetime = date_create( '@' . $timestamp );
	$datetime->setTimezone( $timezone );

	if ( empty( $wp_locale->month ) || empty( $wp_locale->weekday ) ) {
		$date = $datetime->format( $format );
	} else {
		// We need to unpack shorthand `r` format because it has parts that might be localized.
		$format = preg_replace( '/(?<!\\\\)r/', DATE_RFC2822, $format );

		$new_format    = '';
		$format_length = strlen( $format );
		$month         = $wp_locale->get_month( $datetime->format( 'm' ) );
		$weekday       = $wp_locale->get_weekday( $datetime->format( 'w' ) );

		for ( $i = 0; $i < $format_length; $i++ ) {
			switch ( $format[ $i ] ) {
				case 'D':
					$new_format .= addcslashes( $wp_locale->get_weekday_abbrev( $weekday ), '\\A..Za..z' );
					break;
				case 'F':
					$new_format .= addcslashes( $month, '\\A..Za..z' );
					break;
				case 'l':
					$new_format .= addcslashes( $weekday, '\\A..Za..z' );
					break;
				case 'M':
					$new_format .= addcslashes( $wp_locale->get_month_abbrev( $month ), '\\A..Za..z' );
					break;
				case 'a':
					$new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'a' ) ), '\\A..Za..z' );
					break;
				case 'A':
					$new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'A' ) ), '\\A..Za..z' );
					break;
				case '\\':
					$new_format .= $format[ $i ];

					// If character follows a slash, we add it without translating.
					if ( $i < $format_length ) {
						$new_format .= $format[ ++$i ];
					}
					break;
				default:
					$new_format .= $format[ $i ];
					break;
			}
		}

		$date = $datetime->format( $new_format );
		$date = wp_maybe_decline_date( $date, $format );
	}

	/**
	 * Filters the date formatted based on the locale.
	 *
	 * @since 5.3.0
	 *
	 * @param string       $date      Formatted date string.
	 * @param string       $format    Format to display the date.
	 * @param int          $timestamp Unix timestamp.
	 * @param DateTimeZone $timezone  Timezone.
	 */
	$date = apply_filters( 'wp_date', $date, $format, $timestamp, $timezone );

	return $date;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘wp_date’, string $date, string $format, int $timestamp, DateTimeZone $timezone ): Filters the date formatted based on the locale.

Uses	Description
wp_timezone()`wp-includes/functions.php`	Retrieves the timezone of the site as a `DateTimeZone` object.
wp_maybe_decline_date()`wp-includes/functions.php`	Determines if the date should be declined.
WP_Locale::get_month()`wp-includes/class-wp-locale.php`	Retrieves the full translated month by month number.
WP_Locale::get_month_abbrev()`wp-includes/class-wp-locale.php`	Retrieves translated version of month abbreviation string.
WP_Locale::get_meridiem()`wp-includes/class-wp-locale.php`	Retrieves translated version of meridiem string.
WP_Locale::get_weekday()`wp-includes/class-wp-locale.php`	Retrieves the full translated weekday word.
WP_Locale::get_weekday_abbrev()`wp-includes/class-wp-locale.php`	Retrieves the translated weekday abbreviation.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 3 more Show less

Used by	Description
WP_Sitemaps_Posts::get_url_list()`wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php`	Gets a URL list for a post type sitemap.
WP_Debug_Data::debug_data()`wp-admin/includes/class-wp-debug-data.php`	Static function for generating site debug data when required.
get_post_time()`wp-includes/general-template.php`	Retrieves the time at which the post was written.
get_post_modified_time()`wp-includes/general-template.php`	Retrieves the time at which the post was last modified.
date_i18n()`wp-includes/functions.php`	Retrieves the date in localized format, based on a sum of Unix timestamp and timezone offset in seconds.
mysql2date()`wp-includes/functions.php`	Converts given MySQL date string into a different format.