Changeset 10039 for trunk/src/bp-core/bp-core-cache.php

Timestamp:

08/09/2015 05:07:56 AM (10 years ago)

Author:

tw2113

Message:

More updates to BP-Core docs.

See #6398.

File:

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

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

@@ -2 +2 @@
 /**
  * BuddyPress Core Caching Functions.
+ *
+ * @package BuddyPress
  *
  * Caching functions handle the clearing of cached objects and pages on specific
@@ -38 +40 @@
  * Clear all cached objects for a user, or those that a user is part of.
  *
- * @param string $user_id
+ * @param string $user_id User ID to delete cache for.
  */
 function bp_core_clear_user_object_cache( $user_id ) {
@@ -62 +64 @@
  * @since BuddyPress (2.0.0)
  *
- * @param int $post_id
+ * @param int $post_id ID of the page that was saved.
  */
 function bp_core_clear_directory_pages_cache_page_edit( $post_id ) {
@@ -69 +71 @@
     }
 
-    // Bail if BP is not defined here
+    // Bail if BP is not defined here.
     if ( ! buddypress() ) {
         return;
@@ -185 +187 @@
         'meta_table'       => '',      // Name of the table containing the metadata
         'object_column'    => '',      // DB column for the object ids (group_id, etc)
-        'cache_key_prefix' => ''       // Prefix to use when creating cache key names. Eg
-                                       // 'bp_groups_groupmeta'
+        'cache_key_prefix' => ''       // Prefix to use when creating cache key names. Eg 'bp_groups_groupmeta'
     );
     $r = wp_parse_args( $args, $defaults );