get_post_datetime( int|WP_Post|null $post = null, string $field = 'date', string $source = 'local' ): DateTimeImmutable|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

$postint|WP_Post|nulloptional

Post ID or post object. Default is global $post object.Default: null

$fieldstringoptional

Published or modified time to use from database. Accepts 'date' or 'modified'.
Default 'date'.Default: 'date'

$sourcestringoptional

Local or UTC time to use from database. Accepts 'local' or 'gmt'.
Default 'local'.Default: 'local'

Return value

DateTimeImmutable|false

Time object on success, false on failure.

Performance profile

How much work a call to get_post_datetime() 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

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9–39

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

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

What it touches

• querycontent queryget_post()called directly

Further down the call graph this can also reach option, hook, cache, serialize 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 · 4 distinct outcomes

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

Uses · 3

• get_post()Retrieves post data given a post ID or post object.
• wp_timezone()Retrieves the timezone of the site as a `DateTimeZone` object.
• DateTimeZone::__construct()

Used by · 3

• get_post_modified_time()Retrieves the time at which the post was last modified.
• get_post_time()Retrieves the localized time of the post.
• get_post_timestamp()Retrieves post published or modified time as a Unix timestamp.

Source code

View on Trac ↗View on GitHub ↗

3157function get_post_datetime( $post = null, $field = 'date', $source = 'local' ) {3158	$post = get_post( $post );3159 3160	if ( ! $post ) {3161		return false;3162	}3163 3164	$wp_timezone = wp_timezone();3165 3166	if ( 'gmt' === $source ) {3167		$time     = ( 'modified' === $field ) ? $post->post_modified_gmt : $post->post_date_gmt;3168		$timezone = new DateTimeZone( 'UTC' );3169	} else {3170		$time     = ( 'modified' === $field ) ? $post->post_modified : $post->post_date;3171		$timezone = $wp_timezone;3172	}3173 3174	if ( empty( $time ) || '0000-00-00 00:00:00' === $time ) {3175		return false;3176	}3177 3178	$datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', $time, $timezone );3179 3180	if ( false === $datetime ) {3181		return false;3182	}3183 3184	return $datetime->setTimezone( $wp_timezone );3185}

Changelog

Introduced in 5.3.0. One change 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 7.1.0 tag, from src/wp-includes/general-template.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.