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

Timestamp:

12/04/2013 02:07:20 AM (11 years ago)

Author:

boonebgorges

Message:

Improve documentation in the Groups component. See #5022

File:

• trunk/bp-groups/bp-groups-cache.php (modified) (7 diffs)

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

@@ -15 +15 @@
 
 /**
- * Slurps up groupmeta
+ * Slurp up metadata for a set of groups.
  *
  * This function is called in two places in the BP_Groups_Group class:
@@ -21 +21 @@
  *   - 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
+ * It grabs all groupmeta associated with all of the groups passed in
+ * $group_ids and adds it to WP cache. This improves efficiency when using
+ * groupmeta within a loop context.
  *
- * @param int|str|array $group_ids Accepts a single group_id, or a comma-separated list or array of
- *    group ids
+ * @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 ) {
@@ -41 +42 @@
 }
 
+/**
+ * Clear the cached group count.
+ *
+ * @param $group_id Not used.
+ */
 function groups_clear_group_object_cache( $group_id ) {
     wp_cache_delete( 'bp_total_group_count', 'bp' );
@@ -51 +57 @@
 
 /**
- * Bust group caches when editing or deleting
+ * Bust group caches when editing or deleting.
  *
- * @since BuddyPress (1.7)
- * @param int $group_id The group being edited
+ * @since BuddyPress (1.7.0)
+ *
+ * @param int $group_id The group being edited.
  */
 function bp_groups_delete_group_cache( $group_id = 0 ) {
@@ -66 +73 @@
 
 /**
- * Clears caches for the group creator when a group is created
+ * Clear caches for the group creator when a group is created.
  *
- * @param int $group_id
- * @param BP_Groups_Group $group_obj
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
+ *
+ * @param int $group_id ID of the group.
+ * @param BP_Groups_Group $group_obj Group object.
  */
 function bp_groups_clear_group_creator_cache( $group_id, $group_obj ) {
@@ -81 +89 @@
  * Clears caches for all members in a group when a group is deleted
  *
- * @param BP_Groups_Group $group_obj
- * @param array User IDs who were in this group
- * @since BuddyPress (1.6)
+ * @since BuddyPress (1.6.0)
+ *
+ * @param BP_Groups_Group $group_obj Group object.
+ * @param array User IDs who were in this group.
  */
 function bp_groups_clear_group_members_caches( $group_obj, $user_ids ) {
@@ -92 +101 @@
 add_action( 'bp_groups_delete_group', 'bp_groups_clear_group_members_caches', 10, 2 );
 
+/**
+ * Clear a user's cached group count.
+ *
+ * @param int $group_id ID of the group. Not used in this function.
+ * @param int $user_id ID of the user whose group count is being changed.
+ */
 function groups_clear_group_user_object_cache( $group_id, $user_id ) {
     wp_cache_delete( 'bp_total_groups_for_user_' . $user_id, 'bp' );