<!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>[58283] trunk: REST API: Add batch support to the Users API.</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 { white-space: pre-line; 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/58283">58283</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/58283","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-02 20:01:44 +0000 (Sun, 02 Jun 2024)</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 batch support to the Users API.
Developers can now include /wp/v2/users routes when making a batch API request.
Props alexminza, timothyblynjacobs, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/60895">#60895</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>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</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 2024-06-02 19:25:03 UTC (rev 58282)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php 2024-06-02 20:01:44 UTC (rev 58283)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,6 +25,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $meta;
</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">+ * Whether the controller supports batching.
+ *
+ * @since 6.6.0
+ * @var array
+ */
+ protected $allow_batch = array( 'v1' => true );
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Constructor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,7 +69,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'permission_callback' => array( $this, 'create_item_permissions_check' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'schema' => array( $this, 'get_public_item_schema' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'allow_batch' => $this->allow_batch,
+ 'schema' => array( $this, 'get_public_item_schema' ),
</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">@@ -107,7 +116,8 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'schema' => array( $this, 'get_public_item_schema' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'allow_batch' => $this->allow_batch,
+ 'schema' => array( $this, 'get_public_item_schema' ),
</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></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 2024-06-02 19:25:03 UTC (rev 58282)
+++ trunk/tests/phpunit/tests/rest-api/rest-users-controller.php 2024-06-02 20:01:44 UTC (rev 58283)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -180,6 +180,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/users' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( array( 'v1' => true ), $data['endpoints'][0]['allow_batch'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'view', $data['endpoints'][0]['args']['context']['default'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );
</span><span class="cx" style="display: block; padding: 0 10px"> // Single.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -186,6 +187,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/users/' . self::$user );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( array( 'v1' => true ), $data['endpoints'][0]['allow_batch'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'view', $data['endpoints'][0]['args']['context']['default'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2024-06-02 19:25:03 UTC (rev 58282)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2024-06-02 20:01:44 UTC (rev 58283)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9371,6 +9371,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "methods": [
</span><span class="cx" style="display: block; padding: 0 10px"> "GET"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "allow_batch": {
+ "v1": true
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "args": {
</span><span class="cx" style="display: block; padding: 0 10px"> "context": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Scope under which the request is made; determines fields present in response.",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9514,6 +9517,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "methods": [
</span><span class="cx" style="display: block; padding: 0 10px"> "POST"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "allow_batch": {
+ "v1": true
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "args": {
</span><span class="cx" style="display: block; padding: 0 10px"> "username": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Login name for the user.",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9616,6 +9622,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "methods": [
</span><span class="cx" style="display: block; padding: 0 10px"> "GET"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "allow_batch": {
+ "v1": true
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "args": {
</span><span class="cx" style="display: block; padding: 0 10px"> "id": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Unique identifier for the user.",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9641,6 +9650,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "PUT",
</span><span class="cx" style="display: block; padding: 0 10px"> "PATCH"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "allow_batch": {
+ "v1": true
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "args": {
</span><span class="cx" style="display: block; padding: 0 10px"> "id": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Unique identifier for the user.",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9733,6 +9745,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "methods": [
</span><span class="cx" style="display: block; padding: 0 10px"> "DELETE"
</span><span class="cx" style="display: block; padding: 0 10px"> ],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "allow_batch": {
+ "v1": true
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "args": {
</span><span class="cx" style="display: block; padding: 0 10px"> "id": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Unique identifier for the user.",
</span></span></pre>
</div>
</div>
</body>
</html>