Changeset 39090

Timestamp:

11/02/2016 06:23:12 AM (8 years ago)

Author:

rmccue

Message:

REST API: Add locale to user resource.

Props ocean90, joehoyle.
Fixes #38528.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-users-controller.php (modified) (7 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

@@ -697 +697 @@
         }
 
+        if ( ! empty( $schema['properties']['locale'] ) ) {
+            $data['locale'] = get_user_locale( $user );
+        }
+
         if ( ! empty( $schema['properties']['nickname'] ) ) {
             $data['nickname'] = $user->nickname;
@@ -832 +836 @@
         if ( isset( $request['url'] ) && ! empty( $schema['properties']['url'] ) ) {
             $prepared_user->user_url = $request['url'];
+        }
+
+        if ( isset( $request['locale'] ) && ! empty( $schema['properties']['locale'] ) ) {
+            $prepared_user->locale = $request['locale'];
         }
 
@@ -978 +986 @@
                     'context'     => array( 'embed', 'view', 'edit' ),
                     'readonly'    => true,
+                ),
+                'locale'    => array(
+                    'description' => __( 'Locale for the resource.' ),
+                    'type'        => 'string',
+                    'enum'        => get_available_languages(),
+                    'context'     => array( 'edit' ),
                 ),
                 'nickname'    => array(

trunk/tests/phpunit/tests/rest-api/rest-users-controller.php

@@ -778 +778 @@
             'first_name' => 'Old Name',
             'user_url' => 'http://apple.com',
+            'locale' => 'en_US',
         ));
         $this->allow_user_to_manage_multisite();
@@ -789 +790 @@
         $_POST['first_name'] = 'New Name';
         $_POST['url'] = 'http://google.com';
+        $_POST['locale'] = 'de_DE';
 
         $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/users/%d', $user_id ) );
@@ -805 +807 @@
         $this->assertEquals( 'http://google.com', $new_data['url'] );
         $this->assertEquals( 'http://google.com', $user->user_url );
+        $this->assertEquals( 'de_DE', $user->locale );
 
         // Check that we haven't inadvertently changed the user's password,
@@ -822 +825 @@
         $this->assertInstanceOf( 'WP_Error', $response->as_error() );
         $this->assertEquals( 'rest_user_invalid_email', $response->as_error()->get_error_code() );
+    }
+
+    public function test_update_item_invalid_locale() {
+        $user1 = $this->factory->user->create( array( 'user_login' => 'test_json_user', 'user_email' => 'testjson@example.com' ) );
+        $this->allow_user_to_manage_multisite();
+        wp_set_current_user( self::$user );
+
+        $request = new WP_REST_Request( 'PUT', '/wp/v2/users/' . $user1 );
+        $request->set_param( 'locale', 'klingon' );
+        $response = $this->server->dispatch( $request );
+        $this->assertInstanceOf( 'WP_Error', $response->as_error() );
+        $this->assertEquals( 'rest_invalid_param', $response->as_error()->get_error_code() );
     }
 
@@ -1140 +1155 @@
         $properties = $data['schema']['properties'];
 
-        $this->assertEquals( 18, count( $properties ) );
+        $this->assertEquals( 19, count( $properties ) );
         $this->assertArrayHasKey( 'avatar_urls', $properties );
         $this->assertArrayHasKey( 'capabilities', $properties );
@@ -1150 +1165 @@
         $this->assertArrayHasKey( 'last_name', $properties );
         $this->assertArrayHasKey( 'link', $properties );
+        $this->assertArrayHasKey( 'locale', $properties );
         $this->assertArrayHasKey( 'meta', $properties );
         $this->assertArrayHasKey( 'name', $properties );
@@ -1298 +1314 @@
             $this->assertEquals( $user->user_login, $data['username'] );
             $this->assertEquals( $user->roles, $data['roles'] );
+            $this->assertEquals( get_user_locale( $user ), $data['locale'] );
         }