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

Timestamp:

07/12/2015 12:49:36 AM (9 years ago)

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

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

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

@@ -17 +17 @@
  * When wp-super-cache is installed this function will clear cached pages
  * so that success/error messages are not cached, or time sensitive content.
+ *
+ * @return int
  */
 function bp_core_clear_cache() {
@@ -35 +37 @@
 /**
  * Clear all cached objects for a user, or those that a user is part of.
+ *
+ * @param string $user_id
  */
 function bp_core_clear_user_object_cache( $user_id ) {
@@ -126 +130 @@
  * @since BuddyPress (2.0.0)
  *
- * @param array $item_ids ID list.
+ * @param array  $item_ids    ID list.
  * @param string $cache_group The cache group to check against.
+ *
  * @return array
  */
@@ -154 +159 @@
  * @since BuddyPress (1.6.0)
  *
- * @global $wpdb WordPress database object for queries..
+ * @global object $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.
+ *     @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.
  */
@@ -180 +186 @@
         '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'
+                                       // 'bp_groups_groupmeta'
     );
     $r = wp_parse_args( $args, $defaults );