Docs: Add TimezoneChange XML doc

See #1722.
WordPress · Jun 20, 2019 · d0a8c67 · d0a8c67
1 parent d202e46
commit d0a8c67
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/WordPress/Docs/WP/TimezoneChangeStandard.xml b/WordPress/Docs/WP/TimezoneChangeStandard.xml
@@ -0,0 +1,22 @@
+<documentation title="Disallow the changing of timezone.">
+    <standard>
+    <![CDATA[
+      Using date_default_timezone_set() and similar isn't allowed, instead use WP internal timezone support.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: Using WP internal timezone support.">
+        <![CDATA[
+$date = new DateTime();
+$date->setTimezone(
+    new DateTimeZone( 'America/Toronto' )
+);
+        ]]>
+        </code>
+        <code title="Invalid: date_default_timezone_set() is used.">
+        <![CDATA[
+date_default_timezone_set( 'Foo/Bar' );
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>