<!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>[25488] trunk: Introduce 'offset' parameter for wp_get_sites().</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25488">25488</a></dd>
<dt>Author</dt> <dd>SergeyBiryukov</dd>
<dt>Date</dt> <dd>2013-09-19 01:46:03 +0000 (Thu, 19 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce 'offset' parameter for wp_get_sites().
props jamescollins.
see <a href="http://core.trac.wordpress.org/ticket/14511">#14511</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmsfunctionsphp">trunk/src/wp-includes/ms-functions.php</a></li>
<li><a href="#trunktestsphpunittestsmsphp">trunk/tests/phpunit/tests/ms.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/ms-functions.php (25487 => 25488)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/ms-functions.php 2013-09-19 01:19:56 UTC (rev 25487)
+++ trunk/src/wp-includes/ms-functions.php 2013-09-19 01:46:03 UTC (rev 25488)
</span><span class="lines">@@ -2007,6 +2007,7 @@
</span><span class="cx"> * @type int 'spam' Retrieve spam or non-spam sites. Default null, for any.
</span><span class="cx"> * @type int 'deleted' Retrieve deleted or non-deleted sites. Default null, for any.
</span><span class="cx"> * @type int 'limit' Number of sites to limit the query to. Default 100.
</span><ins>+ * @type int 'offset' Exclude the first x sites. Used in combination with the limit parameter. Default 0.
</ins><span class="cx"> * }
</span><span class="cx"> *
</span><span class="cx"> * @return array An array of site data
</span><span class="lines">@@ -2025,6 +2026,7 @@
</span><span class="cx"> 'spam' => null,
</span><span class="cx"> 'deleted' => null,
</span><span class="cx"> 'limit' => 100,
</span><ins>+ 'offset' => 0,
</ins><span class="cx"> );
</span><span class="cx">
</span><span class="cx"> $args = wp_parse_args( $args, $defaults );
</span><span class="lines">@@ -2051,8 +2053,12 @@
</span><span class="cx"> if ( isset( $args['deleted'] ) )
</span><span class="cx"> $query .= $wpdb->prepare( "AND deleted = %d ", $args['deleted'] );
</span><span class="cx">
</span><del>- if ( isset( $args['limit'] ) )
- $query .= $wpdb->prepare( "LIMIT %d ", $args['limit'] );
</del><ins>+ if ( isset( $args['limit'] ) && $args['limit'] ) {
+ if ( isset( $args['offset'] ) && $args['offset'] )
+ $query .= $wpdb->prepare( "LIMIT %d , %d ", $args['offset'], $args['limit'] );
+ else
+ $query .= $wpdb->prepare( "LIMIT %d ", $args['limit'] );
+ }
</ins><span class="cx">
</span><span class="cx"> $site_results = $wpdb->get_results( $query, ARRAY_A );
</span><span class="cx">
</span></span></pre></div>
<a id="trunktestsphpunittestsmsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/ms.php (25487 => 25488)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/ms.php 2013-09-19 01:19:56 UTC (rev 25487)
+++ trunk/tests/phpunit/tests/ms.php 2013-09-19 01:46:03 UTC (rev 25488)
</span><span class="lines">@@ -1033,7 +1033,6 @@
</span><span class="cx"> * @ticket 14511
</span><span class="cx"> */
</span><span class="cx"> function test_wp_get_sites() {
</span><del>- global $wpdb;
</del><span class="cx"> $this->factory->blog->create_many( 2, array( 'site_id' => 2, 'meta' => array( 'public' => 1 ) ) );
</span><span class="cx"> $this->factory->blog->create_many( 3, array( 'site_id' => 3, 'meta' => array( 'public' => 0 ) ) );
</span><span class="cx">
</span><span class="lines">@@ -1069,6 +1068,29 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * @ticket 14511
+ */
+ function test_wp_get_sites_limit_offset() {
+ // Create 4 more sites (in addition to the default one)
+ $this->factory->blog->create_many( 4, array( 'meta' => array( 'public' => 1 ) ) );
+
+ // Expect all 5 sites when no limit/offset is specified
+ $this->assertCount( 5, wp_get_sites() );
+
+ // Expect first 2 sites when using limit
+ $this->assertCount( 2, wp_get_sites( array( 'limit' => 2 ) ) );
+
+ // Expect only the last 3 sites when using offset of 2 (limit will default to 100)
+ $this->assertCount( 3, wp_get_sites( array( 'offset' => 2 ) ) );
+
+ // Expect only the last 1 site when using offset of 4 and limit of 2
+ $this->assertCount( 1, wp_get_sites( array( 'limit' => 2, 'offset' => 4 ) ) );
+
+ // Expect 0 sites when using an offset larger than the number of sites
+ $this->assertCount( 0, wp_get_sites( array( 'offset' => 20 ) ) );
+ }
+
+ /**
</ins><span class="cx"> * Test the 'archived' argument for wp_get_sites().
</span><span class="cx"> *
</span><span class="cx"> * archived is an ENUM, not an integer field.
</span></span></pre>
</div>
</div>
</body>
</html>