<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[45901] trunk/src/wp-includes: Date/Time: Introduce `wp_date()` to retrieve the date in localized format.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/45901">45901</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/45901","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-08-28 00:51:16 +0000 (Wed, 28 Aug 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Date/Time: Introduce `wp_date()` to retrieve the date in localized format.
Convert `date_i18n()` into a wrapper for `wp_date()`.
`wp_date()` is intended as a replacement for `date_i18n()` without legacy quirks in it. It accepts a true Unix timestamp (not summed with timezone offset) and an arbitrary timezone.
Props Rarst, mboynes, MikeHansenMe, rmccue, nacin.
Fixes <a href="https://core.trac.wordpress.org/ticket/28636">#28636</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2019-08-27 21:54:58 UTC (rev 45900)
+++ trunk/src/wp-includes/default-filters.php 2019-08-28 00:51:16 UTC (rev 45901)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -209,8 +209,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'widget_text_content', 'shortcode_unautop' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'widget_text_content', 'do_shortcode', 11 ); // Runs after wpautop(); note that $post global will be null when shortcodes run.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-add_filter( 'date_i18n', 'wp_maybe_decline_date' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // RSS filters
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'the_title_rss', 'strip_tags' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'the_title_rss', 'ent2ncr', 8 );
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2019-08-27 21:54:58 UTC (rev 45900)
+++ trunk/src/wp-includes/functions.php 2019-08-28 00:51:16 UTC (rev 45901)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,7 +91,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieves the timezone from current settings as a string.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the timezone from site settings as a string.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Uses the `timezone_string` option to get a proper timezone if available,
</span><span class="cx" style="display: block; padding: 0 10px"> * otherwise falls back to an offset.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -120,7 +120,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieves the timezone from current settings as a `DateTimeZone` object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the timezone from site settings as a `DateTimeZone` object.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Timezone can be based on a PHP timezone string or a ±HH:MM offset.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -146,63 +146,101 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * will lead to invalid output.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 0.71
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 Converted into a wrapper for wp_date().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Locale $wp_locale WordPress date and time locale object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $dateformatstring Format to display the date.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $format Format to display the date.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int|bool $timestamp_with_offset Optional. A sum of Unix timestamp and timezone offset in seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $gmt Optional. Whether to use GMT timezone. Only applies if timestamp is
</span><span class="cx" style="display: block; padding: 0 10px"> * not provided. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @return string The date, translated if locale specifies it.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function date_i18n( $dateformatstring, $timestamp_with_offset = false, $gmt = false ) {
- global $wp_locale;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function date_i18n( $format, $timestamp_with_offset = false, $gmt = false ) {
+ // If timestamp is omitted it should be current time (summed with offset, unless `$gmt` is true).
+ $timestamp = $timestamp_with_offset ? $timestamp_with_offset : current_time( 'timestamp', $gmt );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $i = $timestamp_with_offset;
-
- if ( ! is_numeric( $i ) ) {
- $i = current_time( 'timestamp', $gmt );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * This is a legacy implementation quirk that the returned timestamp is also with offset.
+ * Ideally this function should never be used to produce a timestamp.
+ */
+ if ( 'U' === $format ) {
+ $date = $timestamp;
+ } elseif ( $gmt && ! $timestamp_with_offset ) { // Current time in UTC.
+ $date = wp_date( $format, null, new DateTimeZone( 'UTC' ) );
+ } elseif ( ! $timestamp_with_offset ) { // Current time in site's timezone.
+ $date = wp_date( $format );
+ } else {
+ /*
+ * Timestamp with offset is typically produced by a UTC `strtotime()` call on an input without timezone.
+ * This is the best attempt to reverse that operation into a local time to use.
+ */
+ $local_time = gmdate( 'Y-m-d H:i:s', $timestamp );
+ $timezone = wp_timezone();
+ $datetime = date_create( $local_time, $timezone );
+ $date = wp_date( $format, $datetime->getTimestamp(), $timezone );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Store original value for language with untypical grammars.
- * See https://core.trac.wordpress.org/ticket/9396
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the date formatted based on the locale.
+ *
+ * @since 2.8.0
+ *
+ * @param string $date Formatted date string.
+ * @param string $format Format to display the date.
+ * @param int $timestamp A sum of Unix timestamp and timezone offset in seconds.
+ * Might be without offset if input omitted timestamp but requested GMT.
+ * @param bool $gmt Whether to use GMT timezone. Only applies if timestamp was not provided.
+ * Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $req_format = $dateformatstring;
- $new_format = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $date = apply_filters( 'date_i18n', $date, $format, $timestamp, $gmt );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We need to unpack shorthand `r` format because it has parts that might be localized.
- $dateformatstring = preg_replace( '/(?<!\\\\)r/', DATE_RFC2822, $dateformatstring );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $date;
+}
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Timestamp with offset is typically produced by a UTC `strtotime()` call on an input without timezone.
- * This is the best attempt to reverse that operation into a local time to use.
- */
- $local_time = gmdate( 'Y-m-d H:i:s', $i );
- $gmt_mode = $gmt && ( false === $timestamp_with_offset );
- $timezone = $gmt_mode ? new DateTimeZone( 'UTC' ) : wp_timezone();
- $datetime = date_create( $local_time, $timezone );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Retrieves the date, in localized format.
+ *
+ * This is a newer function, intended to replace `date_i18n()` without legacy quirks in it.
+ *
+ * Note that, unlike `date_i18n()`, this function accepts a true Unix timestamp, not summed with timezone offset.
+ *
+ * @since 5.3.0
+ *
+ * @param string $format PHP date format.
+ * @param int $timestamp Optional. Unix timestamp. Defaults to current time.
+ * @param DateTimeZone $timezone Optional. Timezone to output result in. Defaults to timezone from site settings.
+ *
+ * @return string The date, translated if locale specifies it.
+ */
+function wp_date( $format, $timestamp = null, $timezone = null ) {
+ global $wp_locale;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * This is a legacy implementation quirk that the returned timestamp is also with offset.
- * Ideally this function should never be used to produce a timestamp.
- */
- $timestamp_mode = ( 'U' === $dateformatstring );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $timestamp ) {
+ $timestamp = time();
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $timestamp_mode ) {
- $new_format = $i;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $timezone ) {
+ $timezone = wp_timezone();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $timestamp_mode && ! empty( $wp_locale->month ) && ! empty( $wp_locale->weekday ) ) {
- $month = $wp_locale->get_month( $datetime->format( 'm' ) );
- $weekday = $wp_locale->get_weekday( $datetime->format( 'w' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $datetime = date_create( '@' . $timestamp );
+ $datetime->setTimezone( $timezone );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $format_length = strlen( $dateformatstring );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $wp_locale->month ) || empty( $wp_locale->weekday ) ) {
+ $date = $datetime->format( $format );
+ } else {
+ // We need to unpack shorthand `r` format because it has parts that might be localized.
+ $format = preg_replace( '/(?<!\\\\)r/', DATE_RFC2822, $format );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_format = '';
+ $format_length = strlen( $format );
+ $month = $wp_locale->get_month( $datetime->format( 'm' ) );
+ $weekday = $wp_locale->get_weekday( $datetime->format( 'w' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> for ( $i = 0; $i < $format_length; $i ++ ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch ( $dateformatstring[ $i ] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ switch ( $format[ $i ] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'D':
</span><span class="cx" style="display: block; padding: 0 10px"> $new_format .= backslashit( $wp_locale->get_weekday_abbrev( $weekday ) );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -222,36 +260,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $new_format .= backslashit( $wp_locale->get_meridiem( $datetime->format( 'A' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> case '\\':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_format .= $dateformatstring[ $i ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_format .= $format[ $i ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If character follows a slash, we add it without translating.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $i < $format_length ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_format .= $dateformatstring[ ++$i ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_format .= $format[ ++$i ];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> default:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_format .= $dateformatstring[ $i ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_format .= $format[ $i ];
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $date = $datetime->format( $new_format );
+ $date = wp_maybe_decline_date( $date );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $j = $datetime->format( $new_format );
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the date formatted based on the locale.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 2.8.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $j Formatted date string.
- * @param string $req_format Format to display the date.
- * @param int $i A sum of Unix timestamp and timezone offset in seconds.
- * @param bool $gmt Whether to use GMT timezone. Only applies if timestamp was
- * not provided. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $date Formatted date string.
+ * @param string $format Format to display the date.
+ * @param int $timestamp Unix timestamp.
+ * @param DateTimeZone $timezone Timezone.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $j = apply_filters( 'date_i18n', $j, $req_format, $i, $gmt );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $date = apply_filters( 'wp_date', $date, $format, $timestamp, $timezone );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $j;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $date;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>