get_gmt_from_date( string $date_string, string $format = 'Y-m-d H:i:s' ): string
- Since
- 1.2.0
- Source
wp-includes/formatting.php:3652
Description
Requires and returns a date in the Y-m-d H:i:s format.
Return format can be overridden using the $format parameter.
Compatibility
- WordPress
- since 1.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$date_stringstring- The date to be converted, in the timezone of the site.
$formatstringoptional- The format string for the returned date. Default 'Y-m-d H:i:s'.Default:
'Y-m-d H:i:s'
Return value
string- Formatted version of the date, in UTC.
Performance profile
How much work a call to get_gmt_from_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
- Trivial
- Scaling
- Constant
- Instructions
- 16–21
- Plugin surface
- None
- Called by
- 9
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 26.
Nothing here hands control to plugin code.
9 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_gmt_from_date() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$datetime === false | 16 | wp_timezone(), date_create(), gmdate() |
$datetime !== false | 21 | wp_timezone(), date_create(), ->setTimezone(), ->format() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 26 instructions, 16–21 executed per call, 1 branch. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- wp_timezone()Retrieves the timezone of the site as a `DateTimeZone` object.
- DateTimeZone::__construct()
Used by · 9
- WP_Customize_Manager::save()Handles customize_save WP Ajax request to save/update a changeset.
- WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
- _future_post_hook()Hook used to schedule publication for a post marked for the future.
- _wp_translate_postdata()Renames `$_POST` data from form names to DB post columns.
- rest_get_date_with_gmt()Parses a date into both its local and UTC equivalent, in MySQL datetime format.
- wp_insert_comment()Inserts a comment into the database.
- wp_insert_post()Inserts or update a post.
- wp_update_comment()Updates an existing comment in the database.
- wp_xmlrpc_server::_convert_date_gmt()Converts a WordPress GMT date string to an IXR_Date object.
Source code
function get_gmt_from_date( $date_string, $format = 'Y-m-d H:i:s' ) { $datetime = date_create( $date_string, wp_timezone() ); if ( false === $datetime ) { return gmdate( $format, 0 ); } return $datetime->setTimezone( new DateTimeZone( 'UTC' ) )->format( $format );}Changelog
Introduced in 1.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/formatting.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.