Using get_gmt_from_date to convert dates to GMT time in WordPress

The get_gmt_from_date function in WordPress is a built-in function that performs the task of converting a date string into a GMT date string. This function is part of the WordPress core and is typically used for date manipulation within the WordPress environment.

When working with dates and times in WordPress, developers often need to ensure that their code is sensitive to different time zones. The get_gmt_from_date function can assist with this by converting any given date into Greenwich Mean Time (GMT), which is a time standard that is independent of time zones. This can be particularly important when dealing with international audiences or when coordinating events or posts that need to occur at a specific universal time.

It’s important to note that the get_gmt_from_date function only performs a conversion and does not modify the original date. The output of this function is a new date string that represents the GMT equivalent of the input date.

Parameters

The get_gmt_from_date function in WordPress accepts two parameters as inputs:

  • $date_string(string): This is a required parameter. It refers to the date that needs to be converted. The date should be in the site’s timezone.
  • $format(string): This parameter is optional. If not specified, the default value ‘Y-m-d H:i:s’ is used. It defines the format string for the date that will be returned.

Return Value

The get_gmt_from_date function returns a string. This string is the formatted version of the input date, but in UTC.

If the function does not accept any parameters, it will be explicitly mentioned in the function’s description.

Examples

How to Convert a Local Time to GMT in WordPress

$date = '2022-01-01 12:00:00';
$gmt_date = get_gmt_from_date($date);
echo '<p>GMT Date: ' . $gmt_date . '</p>';

In this example, the get_gmt_from_date() function is used to convert a local time to GMT. The input date is ‘2022-01-01 12:00:00’. The function returns the GMT equivalent of this date, which is then echoed out wrapped in a <p> tag.

How to Convert a Post’s Published Date to GMT in WordPress

$post_id = 123; 
$post_date = get_the_date('Y-m-d H:i:s', $post_id);
$gmt_date = get_gmt_from_date($post_date);
echo '<p>Post GMT Date: ' . $gmt_date . '</p>';

In this example, the get_gmt_from_date() function is used to convert a post’s published date to GMT. The function get_the_date() is used to get the local publish date of the post. This date is then converted to GMT using the get_gmt_from_date() function and echoed out wrapped in a <p> tag.

How to Use the get_gmt_from_date Function in a Conditional Statement in WordPress

$post_id = 123; 
$post_date = get_the_date('Y-m-d H:i:s', $post_id);
$gmt_date = get_gmt_from_date($post_date);

if($gmt_date > '2022-01-01 00:00:00') {
 echo '<p>The post was published after the start of 2022 in GMT.</p>';
} else {
 echo '<p>The post was published before the start of 2022 in GMT.</p>';
}

In this example, the get_gmt_from_date() function is used within a conditional statement. The function get_the_date() is used to get the local publish date of the post. This date is then converted to GMT using the get_gmt_from_date() function. An if-else statement is then used to check if the GMT date is after ‘2022-01-01 00:00:00’. If it is, a message is echoed out stating that the post was published after the start of 2022 in GMT. If it isn’t, a message is echoed out stating that the post was published before the start of 2022 in GMT.

Conclusion

The get_gmt_from_date function is a tool in programming that converts a local date, in the ‘Y-m-d H:i:s’ format, into a GMT date. This function is particularly beneficial when working with date and time data that spans across different time zones. By converting local times into a standardized GMT format, it allows for more accurate and consistent comparisons and computations. Therefore, get_gmt_from_date is a valuable function for managing and manipulating date and time data in a global context.

Related WordPress Functions

in WordPress Functions