Changeset 9182 for trunk/src/bp-messages/bp-messages-cache.php

Timestamp:

11/26/2014 06:08:03 AM (11 years ago)

Author:

r-a-y

Message:

Messages: Introduces meta table and related cache functions.

This commit alters the messages DB schema to add a meta table, which will
allow plugin developers to record information about a message.

The new message meta functions in bp-messages-functions.php mirrors those
in other BP components (activity, groups, etc.).

The DB version is also bumped to 9181.

See #3083.

File:

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

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

@@ -12 +12 @@
 // Exit if accessed directly
 if ( !defined( 'ABSPATH' ) ) exit;
+
+/**
+ * Slurp up metadata for a set of messages.
+ *
+ * It grabs all message meta associated with all of the messages passed in
+ * $message_ids and adds it to WP cache. This improves efficiency when using
+ * message meta within a loop context.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param int|str|array $message_ids Accepts a single message_id, or a
+ *        comma-separated list or array of message ids.
+ */
+function bp_messages_update_meta_cache( $message_ids = false ) {
+    bp_update_meta_cache( array(
+        'object_ids'       => $message_ids,
+        'object_type'      => buddypress()->messages->id,
+        'cache_group'      => 'message_meta',
+        'object_column'    => 'message_id',
+        'meta_table'       => buddypress()->messages->table_name_meta,
+        'cache_key_prefix' => 'bp_messages_meta'
+    ) );
+}
 
 // List actions to clear super cached pages on, if super cache is installed