Changeset 7434 for trunk/bp-core/bp-core-cache.php

Timestamp:

10/16/2013 05:41:34 PM (11 years ago)

Author:

boonebgorges

Message:

Improve inline docs in bp-core. See #5022

File:

• trunk/bp-core/bp-core-cache.php (modified) (6 diffs)

trunk/bp-core/bp-core-cache.php

@@ -1 +1 @@
 <?php
 /**
+ * BuddyPress Core Caching Functions.
+ *
  * Caching functions handle the clearing of cached objects and pages on specific
  * actions throughout BuddyPress.
@@ -9 +11 @@
 
 /**
- * REQUIRES WP-SUPER-CACHE
+ * Prune the WP Super Cache.
+ *
+ * @see prune_super_cache()
  *
  * When wp-super-cache is installed this function will clear cached pages
  * so that success/error messages are not cached, or time sensitive content.
- *
- * @package BuddyPress Core
  */
 function bp_core_clear_cache() {
@@ -26 +28 @@
 
 /**
- * Add's 'bp' to global group of network wide cachable objects
- *
- * @package BuddyPress Core
+ * Add 'bp' to global group of network wide cachable objects.
  */
 function bp_core_add_global_group() {
@@ -38 +38 @@
 
 /**
- * Clears all cached objects for a user, or a user is part of.
- *
- * @package BuddyPress Core
+ * Clear all cached objects for a user, or those that a user is part of.
  */
 function bp_core_clear_user_object_cache( $user_id ) {
@@ -47 +45 @@
 
 /**
- * Clears member count caches and transients
+ * Clear member count caches and transients.
  */
 function bp_core_clear_member_count_caches() {
@@ -62 +60 @@
  * Update the metadata cache for the specified objects.
  *
- * @since BuddyPress (1.6)
- * @global $wpdb WordPress database object for queries.
- * @param array $args See $defaults definition for more details
- * @return mixed Metadata cache for the specified objects, or false on failure.
+ * Based on WordPress's {@link update_meta_cache()}, this function primes the
+ * cache with metadata related to a set of objects. This is typically done when
+ * querying for a loop of objects; pre-fetching metadata for each queried
+ * object can lead to dramatic performance improvements when using metadata
+ * in the context of template loops.
+ *
+ * @since BuddyPress (1.6.0)
+ *
+ * @global $wpdb WordPress database object for queries..
+ *
+ * @param array $args {
+ *     Array of arguments.
+ *     @type array|string $object_ids List of object IDs to fetch metadata for.
+ *           Accepts an array or a comma-separated list of numeric IDs.
+ *     @type string $object_type The type of object, eg 'groups' or 'activity'.
+ *     @type string $meta_table The name of the metadata table being queried.
+ *     @type string $object_column Optional. The name of the database column
+ *           where IDs (those provided by $object_ids) are found. Eg, 'group_id'
+ *           for the groups metadata tables. Default: $object_type . '_id'.
+ *     @type string $cache_key_prefix Optional. The prefix to use when creating
+ *           cache key names. Default: the value of $meta_table.
+ * }
+ * @return array|bool Metadata cache for the specified objects, or false on failure.
  */
 function bp_update_meta_cache( $args = array() ) {