<!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>[39177] trunk: REST API: Fire correct hooks when creating users on multiste.</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/39177">39177</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/39177","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-09 01:34:56 +0000 (Wed, 09 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: Fire correct hooks when creating users on multiste.
`add_user_to_blog()` is now called, ensuring the correct hooks are called, along with setting the primary blog and clearing relevant caches.
Props jeremyfelt.
Fixes <a href="https://core.trac.wordpress.org/ticket/38526">#38526</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="#trunktestsphpunitincludestestcaserestcontrollerphp">trunk/tests/phpunit/includes/testcase-rest-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-09 01:11:59 UTC (rev 39176)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2016-11-09 01:34:56 UTC (rev 39177)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -434,6 +434,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $user_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $user_id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ add_user_to_blog( get_site()->id, $user_id, '' );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = wp_insert_user( $user );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -558,6 +560,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $user = get_user_by( 'id', $id );
</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 ( is_multisite() && ! is_user_member_of_blog( $id ) ) {
+ add_user_to_blog( get_current_blog_id(), $id, '' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $request['roles'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> array_map( array( $user, 'add_role' ), $request['roles'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitincludestestcaserestcontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/testcase-rest-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/testcase-rest-controller.php 2016-11-09 01:11:59 UTC (rev 39176)
+++ trunk/tests/phpunit/includes/testcase-rest-controller.php 2016-11-09 01:34:56 UTC (rev 39177)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,8 +40,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> abstract public function test_get_item_schema();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function filter_rest_url_for_leading_slash( $url, $path ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_multisite() ) {
+ return $url;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Make sure path for rest_url has a leading slash for proper resolution.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertTrue( 0 === strpos( $path, '/' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertTrue( 0 === strpos( $path, '/' ), 'REST API URL should have a leading slash.' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $url;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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-09 01:11:59 UTC (rev 39176)
+++ trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2016-11-09 01:34:56 UTC (rev 39177)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,6 +12,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_Test_REST_Users_Controller extends WP_Test_REST_Controller_Testcase {
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $user;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $editor;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static $site;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass( $factory ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::$user = $factory->user->create( array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,11 +22,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'role' => 'editor',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_email' => 'editor@example.com',
</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 ( is_multisite() ) {
+ self::$site = $factory->blog->create( array( 'domain' => 'rest.wordpress.org', 'path' => '/' ) );
+ }
</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"> public static function wpTearDownAfterClass() {
</span><span class="cx" style="display: block; padding: 0 10px"> self::delete_user( self::$user );
</span><span class="cx" style="display: block; padding: 0 10px"> self::delete_user( self::$editor );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( is_multisite() ) {
+ wpmu_delete_blog( self::$site, true );
+ }
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -706,6 +715,142 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->check_add_edit_user_response( $response );
</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_create_new_network_user_on_site_does_not_add_user_to_sub_site() {
+ if ( ! is_multisite() ) {
+ $this->markTestSkipped( 'Test requires multisite.' );
+ }
+
+ $this->allow_user_to_manage_multisite();
+
+ $params = array(
+ 'username' => 'testuser123',
+ 'password' => 'testpassword',
+ 'email' => 'test@example.com',
+ 'name' => 'Test User 123',
+ 'roles' => array( 'editor' ),
+ );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/users' );
+ $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
+ $request->set_body_params( $params );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $user_id = $data['id'];
+
+ $user_is_member = is_user_member_of_blog( $user_id, self::$site );
+
+ wpmu_delete_user( $user_id );
+
+ $this->assertFalse( $user_is_member );
+ }
+
+ public function test_create_new_network_user_on_sub_site_adds_user_to_site() {
+ if ( ! is_multisite() ) {
+ $this->markTestSkipped( 'Test requires multisite.' );
+ }
+
+ $this->allow_user_to_manage_multisite();
+
+ $params = array(
+ 'username' => 'testuser123',
+ 'password' => 'testpassword',
+ 'email' => 'test@example.com',
+ 'name' => 'Test User 123',
+ 'roles' => array( 'editor' ),
+ );
+
+ switch_to_blog( self::$site );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/users' );
+ $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
+ $request->set_body_params( $params );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $user_id = $data['id'];
+
+ restore_current_blog();
+
+ $user_is_member = is_user_member_of_blog( $user_id, self::$site );
+
+ wpmu_delete_user( $user_id );
+
+ $this->assertTrue( $user_is_member );
+ }
+
+ public function test_create_existing_network_user_on_sub_site_has_error() {
+ if ( ! is_multisite() ) {
+ $this->markTestSkipped( 'Test requires multisite.' );
+ }
+
+ $this->allow_user_to_manage_multisite();
+
+ $params = array(
+ 'username' => 'testuser123',
+ 'password' => 'testpassword',
+ 'email' => 'test@example.com',
+ 'name' => 'Test User 123',
+ 'roles' => array( 'editor' ),
+ );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/users' );
+ $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
+ $request->set_body_params( $params );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $user_id = $data['id'];
+
+ switch_to_blog( self::$site );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/users' );
+ $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
+ $request->set_body_params( $params );
+ $switched_response = $this->server->dispatch( $request );
+
+ restore_current_blog();
+
+ wpmu_delete_user( $user_id );
+
+ $this->assertErrorResponse( 'user_name', $switched_response );
+ }
+
+ public function test_update_existing_network_user_on_sub_site_adds_user_to_site() {
+ if ( ! is_multisite() ) {
+ $this->markTestSkipped( 'Test requires multisite.' );
+ }
+
+ $this->allow_user_to_manage_multisite();
+
+ $params = array(
+ 'username' => 'testuser123',
+ 'password' => 'testpassword',
+ 'email' => 'test@example.com',
+ 'name' => 'Test User 123',
+ 'roles' => array( 'editor' ),
+ );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/users' );
+ $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
+ $request->set_body_params( $params );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $user_id = $data['id'];
+
+ switch_to_blog( self::$site );
+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/users/' . $user_id );
+ $request->add_header( 'content-type', 'application/x-www-form-urlencoded' );
+ $request->set_body_params( $params );
+ $this->server->dispatch( $request );
+
+ restore_current_blog();
+
+ $user_is_member = is_user_member_of_blog( $user_id, self::$site );
+
+ wpmu_delete_user( $user_id );
+
+ $this->assertTrue( $user_is_member );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_json_create_user() {
</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></pre>
</div>
</div>
</body>
</html>