<!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>[39090] trunk: REST API: Add locale to user resource.</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 { 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/39090">39090</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/39090","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rmccue</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-02 06:23:12 +0000 (Wed, 02 Nov 2016)</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'>REST API: Add locale to user resource.
Props ocean90, joehoyle.
Fixes <a href="https://core.trac.wordpress.org/ticket/38528">#38528</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestuserscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestuserscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-users-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestuserscontrollerphp"></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/rest-api/endpoints/class-wp-rest-users-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2016-11-02 06:01:49 UTC (rev 39089)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2016-11-02 06:23:12 UTC (rev 39090)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -696,6 +696,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data['link'] = get_author_posts_url( $user->ID, $user->user_nicename );
</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">+ if ( ! empty( $schema['properties']['locale'] ) ) {
+ $data['locale'] = get_user_locale( $user );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['nickname'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data['nickname'] = $user->nickname;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -833,6 +837,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_user->user_url = $request['url'];
</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">+ if ( isset( $request['locale'] ) && ! empty( $schema['properties']['locale'] ) ) {
+ $prepared_user->locale = $request['locale'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // setting roles will be handled outside of this function.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['roles'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_user->role = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -978,6 +986,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'embed', 'view', 'edit' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'readonly' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'locale' => array(
+ 'description' => __( 'Locale for the resource.' ),
+ 'type' => 'string',
+ 'enum' => get_available_languages(),
+ 'context' => array( 'edit' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'nickname' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The nickname for the resource.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestuserscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-users-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2016-11-02 06:01:49 UTC (rev 39089)
+++ trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2016-11-02 06:23:12 UTC (rev 39090)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -777,6 +777,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_login' => 'test_update',
</span><span class="cx" style="display: block; padding: 0 10px"> 'first_name' => 'Old Name',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_url' => 'http://apple.com',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'locale' => 'en_US',
</ins><span class="cx" style="display: block; padding: 0 10px"> ));
</span><span class="cx" style="display: block; padding: 0 10px"> $this->allow_user_to_manage_multisite();
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$user );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -788,6 +789,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST['username'] = $userdata->user_login;
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST['first_name'] = 'New Name';
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST['url'] = 'http://google.com';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $_POST['locale'] = 'de_DE';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/users/%d', $user_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -804,6 +806,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'http://google.com', $new_data['url'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'http://google.com', $user->user_url );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 'de_DE', $user->locale );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check that we haven't inadvertently changed the user's password,
</span><span class="cx" style="display: block; padding: 0 10px"> // as per https://core.trac.wordpress.org/ticket/21429
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -823,6 +826,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'rest_user_invalid_email', $response->as_error()->get_error_code() );
</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">+ 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() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_update_item_username_attempt() {
</span><span class="cx" style="display: block; padding: 0 10px"> $user1 = $this->factory->user->create( array( 'user_login' => 'test_json_user', 'user_email' => 'testjson@example.com' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $user2 = $this->factory->user->create( array( 'user_login' => 'test_json_user2', 'user_email' => 'testjson2@example.com' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1139,7 +1154,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $properties = $data['schema']['properties'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 18, count( $properties ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 19, count( $properties ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'avatar_urls', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'capabilities', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'description', $properties );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1149,6 +1164,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'id', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'last_name', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'link', $properties );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'locale', $properties );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'meta', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'name', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'nickname', $properties );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1297,6 +1313,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( date( 'c', strtotime( $user->user_registered ) ), $data['registered_date'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $user->user_login, $data['username'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $user->roles, $data['roles'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( get_user_locale( $user ), $data['locale'] );
</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"> if ( 'edit' !== $context ) {
</span></span></pre>
</div>
</div>
</body>
</html>