get_date_from_gmt( string $date_string, string $format = 'Y-m-d H:i:s' ): string

Given a date in UTC or GMT timezone, returns that date in the timezone of the site.

Contents

Description

Requires a date in the Y-m-d H:i:s format.
Default return format of ‘Y-m-d H:i:s’ can be overridden using the $format parameter.

Top ↑

Parameters

$date_string string Required
The date to be converted, in UTC or GMT timezone.
$format string Optional
The format string for the returned date.

Default: 'Y-m-d H:i:s'

Top ↑

Return

string Formatted version of the date, in the site's timezone.

Top ↑

Source

File: wp-includes/formatting.php. View all references 

function get_date_from_gmt( $date_string, $format = 'Y-m-d H:i:s' ) {
	$datetime = date_create( $date_string, new DateTimeZone( 'UTC' ) );

	if ( false === $datetime ) {
		return gmdate( $format, 0 );
	}

	return $datetime->setTimezone( wp_timezone() )->format( $format );
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
wp_timezone() wp-includes/functions.php

Retrieves the timezone of the site as a DateTimeZone object.

Top ↑

Used By

Used By
Used By Description
wp_resolve_post_date() wp-includes/post.php

Uses wp_checkdate to return a valid Gregorian-calendar value for post_date.
WP_Customize_Manager::save_changeset_post() wp-includes/class-wp-customize-manager.php

Saves the post for the loaded changeset.
rest_get_date_with_gmt() wp-includes/rest-api.php

Parses a date into both its local and UTC equivalent, in MySQL datetime format.
wp_xmlrpc_server::wp_editComment() wp-includes/class-wp-xmlrpc-server.php

Edits a comment.

Top ↑

Changelog

Changelog
Version Description
1.2.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by d4mation —

    get_date_from_gmt() does not accept a Unix Timestamp because date_create() doesn’t.

    If you need to provide a Unix Timestamp, you will need to convert it to a different format first like the following example:

    <?php

$utc_timestamp = 1623096269;

// This is a format that date_create() will accept
$utc_timestamp_converted = date( 'Y-m-d H:i:s', $utc_timestamp );

$output_format = 'Y-m-d H:i:s';

// Now we can use our timestamp with get_date_from_gmt()
$local_timestamp = get_date_from_gmt( $utc_timestamp_converted, $output_format );

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