Changeset 5460 for trunk/bp-groups/bp-groups-cache.php

Timestamp:

12/08/2011 02:57:38 AM (13 years ago)

Author:

boonebgorges

Message:

Introduces automatic meta cache features.
Introduces bp_update_meta_cache(), for collecting all metadata associated with an object or with multiple objects in one fell swoop, and adding it to the WP cache for quicker access later
Introduces bp_groups_update_meta_cache(), for collecting groupmeta at the beginning of a group loop
Modifies the BP_Groups_Group object so that groupmeta is fetched in the populate() and get() methods
Fixes #3799

File:

• trunk/bp-groups/bp-groups-cache.php (modified) (1 diff)

trunk/bp-groups/bp-groups-cache.php

@@ -12 +12 @@
 // Exit if accessed directly
 if ( !defined( 'ABSPATH' ) ) exit;
+
+/**
+ * Slurps up groupmeta
+ *
+ * This function is called in two places in the BP_Groups_Group class:
+ *   - in the populate() method, when single group objects are populated
+ *   - in the get() method, when multiple groups are queried
+ *
+ * It grabs all groupmeta associated with all of the groups passed in $group_ids and adds it to
+ * the WP cache. This improves efficiency when using groupmeta inline
+ *
+ * @param int|str|array $group_ids Accepts a single group_id, or a comma-separated list or array of
+ *    group ids
+ */
+function bp_groups_update_meta_cache( $group_ids = false ) {
+    global $bp;
+    
+    $cache_args = array(
+        'object_ids'       => $group_ids,
+        'object_type'      => $bp->groups->id,
+        'object_column'    => 'group_id',
+        'meta_table'       => $bp->groups->table_name_groupmeta,
+        'cache_key_prefix' => 'bp_groups_groupmeta'
+    );
+    
+    bp_update_meta_cache( $cache_args );
+}
 
 function groups_clear_group_object_cache( $group_id ) {