Changeset 11086

Timestamp:

09/13/2016 02:59:45 AM (10 years ago)

Author:

boonebgorges

Message:

Groups: Prime group administrator cache in group loops.

This saves a database query for each group of which the logged-in user
is a member.

Props r-a-y.
See #5451.

Location:

trunk/src/bp-groups

Files:

• bp-groups-functions.php (modified) (3 diffs)
• bp-groups-template.php (modified) (4 diffs)
• classes/class-bp-groups-group.php (modified) (4 diffs)
• classes/class-bp-groups-member.php (modified) (2 diffs)
• classes/class-bp-groups-template.php (modified) (2 diffs)

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

@@ -685 +685 @@
  * @since 1.2.0
  * @since 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters.
+ * @since 2.7.0 Added `$update_admin_cache` parameter.
  *
  * @param array|string $args {
@@ -714 +715 @@
         'populate_extras'    => true,           // Fetch meta such as is_banned and is_member.
         'update_meta_cache'  => true,           // Pre-fetch groupmeta for queried groups.
+        'update_admin_cache' => false,
     );
 
@@ -733 +735 @@
         'populate_extras'    => $r['populate_extras'],
         'update_meta_cache'  => $r['update_meta_cache'],
+        'update_admin_cache' => $r['update_admin_cache'],
         'order'              => $r['order'],
         'orderby'            => $r['orderby'],

trunk/src/bp-groups/bp-groups-template.php

@@ -104 +104 @@
  * @since 1.0.0
  * @since 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters.
+ * @since 2.7.0 Added `$update_admin_cache` parameter.
  *
  * @param array|string $args {
@@ -139 +140 @@
  *                                            the listed groups. Default: false.
  *     @type bool         $update_meta_cache  Whether to fetch groupmeta for queried groups. Default: true.
+ *     @type bool         $update_admin_cache Whether to pre-fetch group admins for queried groups.
+ *                                            Defaults to true when on a group directory, where this
+ *                                            information is needed in the loop. Otherwise false.
  * }
  * @return bool True if there are groups to display that match the params
@@ -201 +205 @@
         'populate_extras'    => true,
         'update_meta_cache'  => true,
+        'update_admin_cache' => bp_is_groups_directory() || bp_is_user_groups(),
     ), 'has_groups' );
 
@@ -224 +229 @@
         'populate_extras'    => (bool) $r['populate_extras'],
         'update_meta_cache'  => (bool) $r['update_meta_cache'],
+        'update_admin_cache' => (bool) $r['update_admin_cache'],
     ) );
 

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

@@ -729 +729 @@
      * @since 1.6.0
      * @since 2.6.0 Added `$group_type`, `$group_type__in`, and `$group_type__not_in` parameters.
+     * @since 2.7.0 Added `$update_admin_cache` parameter.
      *
      * @param array $args {
@@ -761 +762 @@
      *     @type bool         $update_meta_cache  Whether to pre-fetch groupmeta for the returned groups.
      *                                            Default: true.
+     *     @type bool         $update_admin_cache Whether to pre-fetch administrator IDs for the returned
+     *                                            groups. Default: false.
      *     @type bool         $show_hidden        Whether to include hidden groups in results. Default: false.
      * }
@@ -808 +811 @@
             'populate_extras'    => true,
             'update_meta_cache'  => true,
+            'update_admin_cache' => false,
             'exclude'            => false,
             'show_hidden'        => false,
@@ -1022 +1026 @@
         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_administrator_ids_cache( $group_ids );
         }
 

trunk/src/bp-groups/classes/class-bp-groups-member.php

@@ -1044 +1044 @@
 
         if ( false === $group_admins ) {
-            $bp = buddypress();
-            $group_admins = $wpdb->get_results( $wpdb->prepare( "SELECT user_id, date_modified FROM {$bp->groups->table_name_members} WHERE group_id = %d AND is_admin = 1 AND is_banned = 0", $group_id ) );
-
-            wp_cache_set( $group_id, $group_admins, 'bp_group_admins' );
+            self::prime_group_administrator_ids_cache( array( $group_id ) );
+            $group_admins = wp_cache_get( $group_id, 'bp_group_admins' );
         }
 
@@ -1056 +1054 @@
 
         return $group_admins;
+    }
+
+    /**
+     * Prime the bp_group_admins cache for one or more groups.
+     *
+     * @since 2.7.0
+     *
+     * @param array $group_ids IDs of the groups.
+     * @return bool True on success.
+     */
+    public static function prime_group_administrator_ids_cache( $group_ids ) {
+        global $wpdb;
+
+        $uncached = bp_get_non_cached_ids( $group_ids, 'bp_group_admins' );
+
+        if ( $uncached ) {
+            $bp = buddypress();
+            $uncached_sql = implode( ',', array_map( 'intval', $uncached ) );
+            $group_admins = $wpdb->get_results( "SELECT user_id, group_id, date_modified FROM {$bp->groups->table_name_members} WHERE group_id IN ({$uncached_sql}) AND is_admin = 1 AND is_banned = 0" );
+
+            $groups = array();
+            if ( $group_admins ) {
+                foreach ( $group_admins as $group_admin ) {
+                    $admin_obj = new stdClass();
+                    $admin_obj->user_id = $group_admin->user_id;
+                    $admin_obj->date_modified = $group_admin->date_modified;
+                    $groups[ $group_admin->group_id ][] = $admin_obj;
+                }
+
+                foreach ( $groups as $this_group_id => $this_group_admins ) {
+                    wp_cache_set( $this_group_id, $this_group_admins, 'bp_group_admins' );
+                }
+            }
+        }
     }
 

trunk/src/bp-groups/classes/class-bp-groups-template.php

@@ -173 +173 @@
             'populate_extras'    => true,
             'update_meta_cache'  => true,
+            'update_admin_cache' => false,
         );
 
@@ -229 +230 @@
                 'populate_extras'    => $populate_extras,
                 'update_meta_cache'  => $update_meta_cache,
+                'update_admin_cache' => $update_admin_cache,
                 'show_hidden'        => $show_hidden,
             ) );