<!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>[45853] trunk: Date/Time: Introduce `wp_timezone_string()` and `wp_timezone()` for unified timezone retrieval.</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/45853">45853</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/45853","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-19 19:07:03 +0000 (Mon, 19 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_timezone_string()` and `wp_timezone()` for unified timezone retrieval.
* `wp_timezone_string()` retrieves the timezone from current settings as a string. Uses the `timezone_string` option to get a proper timezone if available, otherwise falls back to an offset.
* `wp_timezone()` retrieves the timezone from current settings as a `DateTimeZone` object. Timezone can be based on a PHP timezone string or a `{U+00B1}HH:MM` offset.
Props Rarst, remcotolsma, johnjamesjacoby, rmccue.
Fixes <a href="https://core.trac.wordpress.org/ticket/24730">#24730</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsdatewpTimezonephp">trunk/tests/phpunit/tests/date/wpTimezone.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-19 16:34:57 UTC (rev 45852)
+++ trunk/src/wp-includes/functions.php 2019-08-19 19:07:03 UTC (rev 45853)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,7 +74,49 @@
</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">- * Retrieve the date in localized format, based on a sum of Unix timestamp and
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the timezone from current settings as a string.
+ *
+ * Uses the `timezone_string` option to get a proper timezone if available,
+ * otherwise falls back to an offset.
+ *
+ * @since 5.3.0
+ *
+ * @return string PHP timezone string or a ±HH:MM offset.
+ */
+function wp_timezone_string() {
+ $timezone_string = get_option( 'timezone_string' );
+
+ if ( $timezone_string ) {
+ return $timezone_string;
+ }
+
+ $offset = (float) get_option( 'gmt_offset' );
+ $hours = (int) $offset;
+ $minutes = ( $offset - $hours );
+
+ $sign = ( $offset < 0 ) ? '-' : '+';
+ $abs_hour = abs( $hours );
+ $abs_mins = abs( $minutes * 60 );
+ $tz_offset = sprintf( '%s%02d:%02d', $sign, $abs_hour, $abs_mins );
+
+ return $tz_offset;
+}
+
+/**
+ * Retrieves the timezone from current settings as a `DateTimeZone` object.
+ *
+ * Timezone can be based on a PHP timezone string or a ±HH:MM offset.
+ *
+ * @since 5.3.0
+ *
+ * @return DateTimeZone Timezone object.
+ */
+function wp_timezone() {
+ return new DateTimeZone( wp_timezone_string() );
+}
+
+/**
+ * Retrieves the date in localized format, based on a sum of Unix timestamp and
</ins><span class="cx" style="display: block; padding: 0 10px"> * timezone offset in seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If the locale specifies the locale month and weekday, then the locale will
</span></span></pre></div>
<a id="trunktestsphpunittestsdatewpTimezonephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/date/wpTimezone.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/wpTimezone.php (rev 0)
+++ trunk/tests/phpunit/tests/date/wpTimezone.php 2019-08-19 19:07:03 UTC (rev 45853)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,111 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group date
+ * @group datetime
+ */
+class Tests_WP_Timezone extends WP_UnitTestCase {
+
+ /**
+ * @ticket 24730
+ *
+ * @dataProvider timezone_offset_provider
+ *
+ * @param float $gmt_offset Numeric offset from UTC.
+ * @param string $tz_name Expected timezone name.
+ */
+ public function test_should_convert_gmt_offset( $gmt_offset, $tz_name ) {
+ delete_option( 'timezone_string' );
+ update_option( 'gmt_offset', $gmt_offset );
+
+ $this->assertEquals( $tz_name, wp_timezone_string() );
+
+ $timezone = wp_timezone();
+
+ $this->assertEquals( $tz_name, $timezone->getName() );
+ }
+
+ /**
+ * @ticket 24730
+ */
+ public function test_should_return_timezone_string() {
+ update_option( 'timezone_string', 'Europe/Kiev' );
+
+ $this->assertEquals( 'Europe/Kiev', wp_timezone_string() );
+
+ $timezone = wp_timezone();
+
+ $this->assertEquals( 'Europe/Kiev', $timezone->getName() );
+ }
+
+ /**
+ * Data provider to test numeric offset conversion.
+ *
+ * @return array
+ */
+ public function timezone_offset_provider() {
+
+ return [
+ [ - 12, '-12:00' ],
+ [ - 11.5, '-11:30' ],
+ [ - 11, '-11:00' ],
+ [ - 10.5, '-10:30' ],
+ [ - 10, '-10:00' ],
+ [ - 9.5, '-09:30' ],
+ [ - 9, '-09:00' ],
+ [ - 8.5, '-08:30' ],
+ [ - 8, '-08:00' ],
+ [ - 7.5, '-07:30' ],
+ [ - 7, '-07:00' ],
+ [ - 6.5, '-06:30' ],
+ [ - 6, '-06:00' ],
+ [ - 5.5, '-05:30' ],
+ [ - 5, '-05:00' ],
+ [ - 4.5, '-04:30' ],
+ [ - 4, '-04:00' ],
+ [ - 3.5, '-03:30' ],
+ [ - 3, '-03:00' ],
+ [ - 2.5, '-02:30' ],
+ [ - 2, '-02:00' ],
+ [ '-1.5', '-01:30' ],
+ [ - 1.5, '-01:30' ],
+ [ - 1, '-01:00' ],
+ [ - 0.5, '-00:30' ],
+ [ 0, '+00:00' ],
+ [ '0', '+00:00' ],
+ [ 0.5, '+00:30' ],
+ [ 1, '+01:00' ],
+ [ 1.5, '+01:30' ],
+ [ '1.5', '+01:30' ],
+ [ 2, '+02:00' ],
+ [ 2.5, '+02:30' ],
+ [ 3, '+03:00' ],
+ [ 3.5, '+03:30' ],
+ [ 4, '+04:00' ],
+ [ 4.5, '+04:30' ],
+ [ 5, '+05:00' ],
+ [ 5.5, '+05:30' ],
+ [ 5.75, '+05:45' ],
+ [ 6, '+06:00' ],
+ [ 6.5, '+06:30' ],
+ [ 7, '+07:00' ],
+ [ 7.5, '+07:30' ],
+ [ 8, '+08:00' ],
+ [ 8.5, '+08:30' ],
+ [ 8.75, '+08:45' ],
+ [ 9, '+09:00' ],
+ [ 9.5, '+09:30' ],
+ [ 10, '+10:00' ],
+ [ 10.5, '+10:30' ],
+ [ 11, '+11:00' ],
+ [ 11.5, '+11:30' ],
+ [ 12, '+12:00' ],
+ [ 12.75, '+12:45' ],
+ [ 13, '+13:00' ],
+ [ 13.75, '+13:45' ],
+ [ 14, '+14:00' ],
+ ];
+ }
+}
+
+
</ins></span></pre>
</div>
</div>
</body>
</html>