wp_date( string $format, int $timestamp = null, DateTimeZone $timezone = null ): string|false

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$formatstring

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 value

string|false

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

Performance profile

How much work a call to wp_date() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

9–66

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 157.

Plugin surface

1 hook

Third-party callbacks on 'wp_date' run inside this call, and their cost is not bounded by anything here.

Called by

6

6 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_date() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_date() runs, in this order:

1. 1
   apply_filters( wp_date )filterline 319 (+75 into the body)

   Filters the date formatted based on the locale.

Uses · 3

• wp_timezone()Retrieves the timezone of the site as a `DateTimeZone` object.
• wp_maybe_decline_date()Determines if the date should be declined.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 6

• WP_Debug_Data::get_wp_server()Gets the WordPress server section of the debug data.
• WP_Sitemaps_Posts::get_url_list()Gets a URL list for a post type sitemap.
• date_i18n()Retrieves the date in localized format, based on a sum of Unix timestamp and timezone offset in seconds.
• get_post_modified_time()Retrieves the time at which the post was last modified.
• get_post_time()Retrieves the localized time of the post.
• mysql2date()Converts given MySQL date string into a different format.

Source code

View on Trac ↗View on GitHub ↗

244function wp_date( $format, $timestamp = null, $timezone = null ) {245	global $wp_locale;246 247	if ( null === $timestamp ) {248		$timestamp = time();249	} elseif ( ! is_numeric( $timestamp ) ) {250		return false;251	}252 253	if ( ! $timezone ) {254		$timezone = wp_timezone();255	}256 257	$datetime = date_create( '@' . $timestamp );258	$datetime->setTimezone( $timezone );259 260	if ( empty( $wp_locale->month ) || empty( $wp_locale->weekday ) ) {261		$date = $datetime->format( $format );262	} else {263		// We need to unpack shorthand `r` format because it has parts that might be localized.264		$format = preg_replace( '/(?<!\\\\)r/', DATE_RFC2822, $format );265 266		$new_format    = '';267		$format_length = strlen( $format );268		$month         = $wp_locale->get_month( $datetime->format( 'm' ) );269		$weekday       = $wp_locale->get_weekday( $datetime->format( 'w' ) );270 271		for ( $i = 0; $i < $format_length; $i++ ) {272			switch ( $format[ $i ] ) {273				case 'D':274					$new_format .= addcslashes( $wp_locale->get_weekday_abbrev( $weekday ), '\\A..Za..z' );275					break;276				case 'F':277					$new_format .= addcslashes( $month, '\\A..Za..z' );278					break;279				case 'l':280					$new_format .= addcslashes( $weekday, '\\A..Za..z' );281					break;282				case 'M':283					$new_format .= addcslashes( $wp_locale->get_month_abbrev( $month ), '\\A..Za..z' );284					break;285				case 'a':286					$new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'a' ) ), '\\A..Za..z' );287					break;288				case 'A':289					$new_format .= addcslashes( $wp_locale->get_meridiem( $datetime->format( 'A' ) ), '\\A..Za..z' );290					break;291				case '\\':292					$new_format .= $format[ $i ];293 294					// If character follows a slash, we add it without translating.295					if ( $i < $format_length ) {296						$new_format .= $format[ ++$i ];297					}298					break;299				default:300					$new_format .= $format[ $i ];301					break;302			}303		}304 305		$date = $datetime->format( $new_format );306		$date = wp_maybe_decline_date( $date, $format );307	}308 309	/**310	 * Filters the date formatted based on the locale.311	 *312	 * @since 5.3.0313	 *314	 * @param string       $date      Formatted date string.315	 * @param string       $format    Format to display the date.316	 * @param int          $timestamp Unix timestamp.317	 * @param DateTimeZone $timezone  Timezone.318	 */319	$date = apply_filters( 'wp_date', $date, $format, $timestamp, $timezone );320 321	return $date;322}

Changelog

Introduced in 5.3.0. 2 changes between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.