Changeset 25488

Timestamp:

09/19/2013 01:46:03 AM (12 years ago)

Author:

SergeyBiryukov

Message:

Introduce 'offset' parameter for wp_get_sites().

props jamescollins.
see #14511.

Location:

trunk

Files:

• src/wp-includes/ms-functions.php (modified) (3 diffs)
• tests/phpunit/tests/ms.php (modified) (2 diffs)

trunk/src/wp-includes/ms-functions.php

@@ -2008 +2008 @@
  *     @type int       'deleted'    Retrieve deleted or non-deleted sites. Default null, for any.
  *     @type int       'limit'      Number of sites to limit the query to. Default 100.
+ *     @type int       'offset'     Exclude the first x sites. Used in combination with the limit parameter. Default 0.
  * }
  *
@@ -2026 +2027 @@
         'deleted'    => null,
         'limit'      => 100,
+        'offset'     => 0,
     );
 
@@ -2052 +2054 @@
         $query .= $wpdb->prepare( "AND deleted = %d ", $args['deleted'] );
 
-    if ( isset( $args['limit'] ) )
-        $query .= $wpdb->prepare( "LIMIT %d ", $args['limit'] );
+    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'] );
+    }
 
     $site_results = $wpdb->get_results( $query, ARRAY_A );

trunk/tests/phpunit/tests/ms.php

@@ -1034 +1034 @@
      */
     function test_wp_get_sites() {
-        global $wpdb;
         $this->factory->blog->create_many( 2, array( 'site_id' => 2, 'meta' => array( 'public' => 1 ) ) );
         $this->factory->blog->create_many( 3, array( 'site_id' => 3, 'meta' => array( 'public' => 0 ) ) );
@@ -1067 +1066 @@
         $this->assertCount( 0, wp_get_sites( array( 'network_id' => 3, 'public' => 1 ) ) );
         $this->assertCount( 3, wp_get_sites( array( 'network_id' => 3, 'public' => 0 ) ) );
+    }
+
+    /**
+     * @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 ) ) );
     }