Changeset 40336

Timestamp:

03/27/2017 07:08:54 AM (8 years ago)

Author:

swissspidy

Message:

REST API: Add gmt_offset and timezone_string to the base /wp-json response.

The site's current timezone offset is an important piece of information for any REST API client that needs to manipulate dates. It has not been
previously available.

Expose both the gmt_offset (the site's current offset from UTC in hours) and timezone_string (which also provides information about daylight
savings time) via the "site info" endpoint (the base /wp-json response).

Also update the wp-api-generated.js fixture file with the changes to the default API responses.

Props sagarkbhatt.
Fixes #39854.

Merges [40238] to the 4.7 branch.

Location:

branches/4.7

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-server.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

branches/4.7/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -1011 +1011 @@
         // General site data.
         $available = array(
-            'name'           => get_option( 'blogname' ),
-            'description'    => get_option( 'blogdescription' ),
-            'url'            => get_option( 'siteurl' ),
-            'home'           => home_url(),
-            'namespaces'     => array_keys( $this->namespaces ),
-            'authentication' => array(),
-            'routes'         => $this->get_data_for_routes( $this->get_routes(), $request['context'] ),
+            'name'            => get_option( 'blogname' ),
+            'description'     => get_option( 'blogdescription' ),
+            'url'             => get_option( 'siteurl' ),
+            'home'            => home_url(),
+            'gmt_offset'      => get_option( 'gmt_offset' ),
+            'timezone_string' => get_option( 'timezone_string' ),
+            'namespaces'      => array_keys( $this->namespaces ),
+            'authentication'  => array(),
+            'routes'          => $this->get_data_for_routes( $this->get_routes(), $request['context'] ),
         );
 

branches/4.7/tests/phpunit/tests/rest-api/rest-server.php

@@ -647 +647 @@
         $this->assertArrayHasKey( 'url', $data );
         $this->assertArrayHasKey( 'home', $data );
+        $this->assertArrayHasKey( 'gmt_offset', $data );
+        $this->assertArrayHasKey( 'timezone_string', $data );
         $this->assertArrayHasKey( 'namespaces', $data );
         $this->assertArrayHasKey( 'authentication', $data );

branches/4.7/tests/qunit/fixtures/wp-api-generated.js

@@ -11 +11 @@
     "url": "http://example.org",
     "home": "http://example.org",
+    "gmt_offset": "0",
+    "timezone_string": "",
     "namespaces": [
         "oembed/1.0",