函数文档

get_gmt_from_date()

💡 云策文档标注

概述

get_gmt_from_date() 函数用于将站点时区中的日期转换为 UTC 时间。它接受日期字符串和可选格式参数,返回格式化后的 UTC 日期。

关键要点

  • 函数接受两个参数:$date_string(必需,站点时区中的日期字符串)和 $format(可选,返回日期格式,默认为 'Y-m-d H:i:s')。
  • 返回值为字符串,表示转换后的 UTC 日期,格式由 $format 指定。
  • 内部使用 date_create() 和 wp_timezone() 处理时区转换,如果日期无效则返回 gmdate() 的默认值。
  • 相关函数包括 get_date_from_gmt()(逆操作)和 wp_timezone()(获取站点时区)。

代码示例

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 );
}

📄 原文内容

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

Description

Requires and returns a date in the Y-m-d H:i:s format.
Return format can be overridden using the $format parameter.

Parameters

$date_stringstringrequired
The date to be converted, in the timezone of the site.
$formatstringrequired
The format string for the returned date. Default ‘Y-m-d H:i:s’.

Return

string Formatted version of the date, in UTC.

Source

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

Version Description
1.2.0 Introduced.

User Contributed Notes