Ticket #7609: 7609.01.diff

src/bp-groups/bp-groups-functions.php

@@ -785 +785 @@
                 'page'               => 1,              // The page to return if limiting per page.
                 'update_meta_cache'  => true,           // Pre-fetch groupmeta for queried groups.
                 'update_admin_cache' => false,
+                'ids_only'           => false,          // Return group IDs only instead of BP_Groups_Group objects.
         );
 
         $r = bp_parse_args( $args, $defaults, 'groups_get_groups' );
@@ -810 +811 @@
                 'update_admin_cache' => $r['update_admin_cache'],
                 'order'              => $r['order'],
                 'orderby'            => $r['orderby'],
+                'ids_only'           => $r['ids_only'],
         ) );
 
         /**

src/bp-groups/classes/class-bp-groups-group.php

@@ -1025 +1025 @@
          *     @type array|string $status             Optional. Array or comma-separated list of group statuses to limit
          *                                            results to. If specified, $show_hidden is ignored.
          *                                            Default: empty array.
+         *     @type bool         $ids_only           Return only group IDs in results, not group objects. Default: false.
+         *                                            If true, meta and admin caches will not be prefetched.
          * }
          * @return array {
          *     @type array $groups Array of group objects returned by the
-         *                         paginated query.
+         *                         paginated query. (IDs only is `ids_only` is true.)
          *     @type int   $total  Total count of all groups matching non-
          *                         paginated query params.
          * }
@@ -1075 +1077 @@
                         'update_admin_cache' => false,
                         'exclude'            => false,
                         'show_hidden'        => false,
-                        'status'             => array()
+                        'status'             => array(),
+                        'ids_only'           => false,
                 );
 
                 $r = wp_parse_args( $args, $defaults );
@@ -1299 +1302 @@
                         $paged_group_ids = $cached;
                 }
 
-                $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
-                if ( $uncached_group_ids ) {
-                        $group_ids_sql = implode( ',', array_map( 'intval', $uncached_group_ids ) );
-                        $group_data_objects = $wpdb->get_results( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id IN ({$group_ids_sql})" );
-                        foreach ( $group_data_objects as $group_data_object ) {
-                                wp_cache_set( $group_data_object->id, $group_data_object, 'bp_groups' );
+                if ( $r['ids_only'] ) {
+                        // We only want the IDs.
+                        $paged_groups = array_map( 'absint', $paged_group_ids );
+                } else {
+                        $uncached_group_ids = bp_get_non_cached_ids( $paged_group_ids, 'bp_groups' );
+                        if ( $uncached_group_ids ) {
+                                $group_ids_sql = implode( ',', array_map( 'intval', $uncached_group_ids ) );
+                                $group_data_objects = $wpdb->get_results( "SELECT g.* FROM {$bp->groups->table_name} g WHERE g.id IN ({$group_ids_sql})" );
+                                foreach ( $group_data_objects as $group_data_object ) {
+                                        wp_cache_set( $group_data_object->id, $group_data_object, 'bp_groups' );
+                                }
+                        }
+
+                        $paged_groups = array();
+                        foreach ( $paged_group_ids as $paged_group_id ) {
+                                $paged_groups[] = new BP_Groups_Group( $paged_group_id );
+                        }
+
+                        $group_ids = array();
+                        foreach ( (array) $paged_groups as $group ) {
+                                $group_ids[] = $group->id;
+                        }
+
+                        // Grab all groupmeta.
+                        if ( ! empty( $r['update_meta_cache'] ) ) {
+                                bp_groups_update_meta_cache( $group_ids );
+                        }
+
+                        // Prefetch all administrator IDs, if requested.
+                        if ( $r['update_admin_cache'] ) {
+                                BP_Groups_Member::prime_group_admins_mods_cache( $group_ids );
+                        }
+
+                        // Set up integer properties needing casting.
+                        $int_props = array(
+                                'id', 'creator_id', 'enable_forum'
+                        );
+
+                        // Integer casting.
+                        foreach ( $paged_groups as $key => $g ) {
+                                foreach ( $int_props as $int_prop ) {
+                                        $paged_groups[ $key ]->{$int_prop} = (int) $paged_groups[ $key ]->{$int_prop};
+                                }
                         }
-                }
 
-                $paged_groups = array();
-                foreach ( $paged_group_ids as $paged_group_id ) {
-                        $paged_groups[] = new BP_Groups_Group( $paged_group_id );
                 }
 
+                // Find the total number of groups in the results set.
                 $total_groups_sql = "SELECT COUNT(DISTINCT g.id) FROM {$sql['from']} $where";
 
                 /**
@@ -1334 +1371 @@
                         $total_groups = (int) $cached;
                 }
 
-                $group_ids = array();
-                foreach ( (array) $paged_groups as $group ) {
-                        $group_ids[] = $group->id;
-                }
-
-                // Grab all groupmeta.
-                if ( ! empty( $r['update_meta_cache'] ) ) {
-                        bp_groups_update_meta_cache( $group_ids );
-                }
-
-                // Prefetch all administrator IDs, if requested.
-                if ( $r['update_admin_cache'] ) {
-                        BP_Groups_Member::prime_group_admins_mods_cache( $group_ids );
-                }
-
-                // Set up integer properties needing casting.
-                $int_props = array(
-                        'id', 'creator_id', 'enable_forum'
-                );
-
-                // Integer casting.
-                foreach ( $paged_groups as $key => $g ) {
-                        foreach ( $int_props as $int_prop ) {
-                                $paged_groups[ $key ]->{$int_prop} = (int) $paged_groups[ $key ]->{$int_prop};
-                        }
-                }
-
-                unset( $sql, $total_sql );
-
                 return array( 'groups' => $paged_groups, 'total' => $total_groups );
         }
 

tests/phpunit/testcases/groups/class-bp-groups-group.php

@@ -2234 +2234 @@
                 $this->assertEqualSets( array( $g1, $g3 ), $found );
         }
 
+        /**
+         * @group get_ids_only
+         */
+        public function test_get_return_ids_only() {
+                $now = time();
+                $g1 = $this->factory->group->create( array(
+                        'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60 ),
+                ) );
+                $g2 = $this->factory->group->create( array(
+                        'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60*2 ),
+                ) );
+                $g3 = $this->factory->group->create( array(
+                        'last_activity' => date( 'Y-m-d H:i:s', $now - 60*60*3 ),
+                )  );
+
+                $groups = BP_Groups_Group::get( array(
+                        'ids_only' => true,
+                ) );
+
+                $this->assertSame( array( $g1, $g2, $g3 ), $groups['groups'] );
+        }
+
 }
 
 /**