<!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>[34531] trunk: Introduce 'paged' parameter for `WP_User_Query`.</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/34531">34531</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/34531","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-25 04:25:20 +0000 (Fri, 25 Sep 2015)</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'>Introduce 'paged' parameter for `WP_User_Query`.

This is an alternative to using 'offset', and manually calculating pagination.
Note that 'paged' works only in conjunction with 'number', the latter of which
provides the per-page value.

Props sebastian.pisula.
Fixes <a href="https://core.trac.wordpress.org/ticket/25145">#25145</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpuserqueryphp">trunk/src/wp-includes/class-wp-user-query.php</a></li>
<li><a href="#trunktestsphpunittestsuserqueryphp">trunk/tests/phpunit/tests/user/query.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpuserqueryphp"></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/class-wp-user-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-user-query.php     2015-09-25 04:04:06 UTC (rev 34530)
+++ trunk/src/wp-includes/class-wp-user-query.php       2015-09-25 04:25:20 UTC (rev 34531)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -83,6 +83,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.2.0 Added 'meta_value_num' support for `$orderby` parameter. Added multi-dimensional array syntax
</span><span class="cx" style="display: block; padding: 0 10px">         *              for `$orderby` parameter.
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.3.0 Added 'has_published_posts' parameter.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * @since 4.4.0 Added 'paged' parameter.
</ins><span class="cx" style="display: block; padding: 0 10px">          * @access public
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @global wpdb $wpdb
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,6 +125,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">         *     @type int          $number              Number of users to limit the query for. Can be used in
</span><span class="cx" style="display: block; padding: 0 10px">         *                                             conjunction with pagination. Value -1 (all) is not supported.
</span><span class="cx" style="display: block; padding: 0 10px">         *                                             Default empty (all users).
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         *     @type int          $paged               When used with number, defines the page of results to return.
+        *                                             Default 1.
</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type bool         $count_total         Whether to count the total number of users found. If pagination
</span><span class="cx" style="display: block; padding: 0 10px">         *                                             is not needed, setting this to false can improve performance.
</span><span class="cx" style="display: block; padding: 0 10px">         *                                             Default true.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,6 +160,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                'order' => 'ASC',
</span><span class="cx" style="display: block; padding: 0 10px">                                'offset' => '',
</span><span class="cx" style="display: block; padding: 0 10px">                                'number' => '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                                'paged' => 1,
</ins><span class="cx" style="display: block; padding: 0 10px">                                 'count_total' => true,
</span><span class="cx" style="display: block; padding: 0 10px">                                'fields' => 'all',
</span><span class="cx" style="display: block; padding: 0 10px">                                'who' => '',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -323,10 +327,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                // limit
</span><span class="cx" style="display: block; padding: 0 10px">                if ( isset( $qv['number'] ) && $qv['number'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        if ( $qv['offset'] )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 if ( $qv['offset'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                                 $this->query_limit = $wpdb->prepare("LIMIT %d, %d", $qv['offset'], $qv['number']);
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        else
-                               $this->query_limit = $wpdb->prepare("LIMIT %d", $qv['number']);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 } else {
+                               $this->query_limit = $wpdb->prepare( "LIMIT %d, %d", $qv['number'] * ( $qv['paged'] - 1 ), $qv['number'] );
+                       }
</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">                $search = '';
</span></span></pre></div>
<a id="trunktestsphpunittestsuserqueryphp"></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/user/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/query.php  2015-09-25 04:04:06 UTC (rev 34530)
+++ trunk/tests/phpunit/tests/user/query.php    2015-09-25 04:25:20 UTC (rev 34531)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -459,7 +459,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                // All values get reset
</span><span class="cx" style="display: block; padding: 0 10px">                $query->prepare_query( array( 'number' => 8 ) );
</span><span class="cx" style="display: block; padding: 0 10px">                $this->assertNotEmpty( $query->query_limit );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $this->assertEquals( 'LIMIT 8', $query->query_limit );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $this->assertEquals( 'LIMIT 0, 8', $query->query_limit );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                // All values get reset
</span><span class="cx" style="display: block; padding: 0 10px">                $query->prepare_query( array( 'fields' => 'all' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -857,4 +857,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                $this->assertEqualSets( $expected, $found );
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+       /**
+        * @ticket 25145
+        */
+       public function test_paged() {
+               $users = $this->factory->user->create_many( 5 );
+
+               $q = new WP_User_Query( array(
+                       'number' => 2,
+                       'paged' => 2,
+                       'orderby' => 'ID',
+                       'order' => 'DESC', // Avoid funkiness with user 1.
+                       'fields' => 'ids',
+               ) );
+
+               $this->assertEquals( array( $users[2], $users[1] ), $q->results );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>

</body>
</html>