Changeset 9887

Timestamp:

05/21/2015 07:56:59 PM (11 years ago)

Author:

johnjamesjacoby

Message:

Notifications: Improve all_for_user cache deletion.

• Introduce bp_notification_before_update action which fires before a Notification is updated
• Introduce bp_notifications_clear_all_for_user_cache() as wrapper for wp_cache_delete() with appropriate cache group and key
• Introduce bp_notifications_clear_all_for_user_cache_before_update() hooked to bp_notification_before_update action, to handle cache deletion before a notification is updated

This change fixes a bug where marking single notifications as read/unread would not show anticipated results, as the all_for_user cache was not being properly cleared.

Props r-a-y. Fixes #6445.

Location:

trunk/src/bp-notifications

Files:

• bp-notifications-cache.php (modified) (4 diffs)
• classes/class-bp-notifications-notification.php (modified) (1 diff)

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

@@ -32 +32 @@
 
 /**
+ * Clear all notifications cache for a given user ID
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param int $user_id The user ID's cache to clear
+ */
+function bp_notifications_clear_all_for_user_cache( $user_id = 0 ) {
+    wp_cache_delete( 'all_for_user_' . $user_id, 'bp_notifications' );
+}
+
+/**
  * Invalidate 'all_for_user_' cache when saving.
  *
@@ -39 +50 @@
  */
 function bp_notifications_clear_all_for_user_cache_after_save( BP_Notifications_Notification $n ) {
-    wp_cache_delete( 'all_for_user_' . $n->user_id, 'bp_notifications' );
+    bp_notifications_clear_all_for_user_cache( $n->user_id );
 }
 add_action( 'bp_notification_after_save', 'bp_notifications_clear_all_for_user_cache_after_save' );
@@ -51 +62 @@
  */
 function bp_notifications_clear_all_for_user_cache_before_delete( $args ) {
+
     // Pull up a list of items matching the args (those about te be deleted)
     $ns = BP_Notifications_Notification::get( $args );
@@ -59 +71 @@
     }
 
-    foreach ( array_unique( $user_ids ) as $user_id ) {
-        wp_cache_delete( 'all_for_user_' . $user_id, 'bp_notifications' );
+    $user_ids = array_unique( $user_ids );
+    foreach ( $user_ids as $user_id ) {
+        bp_notifications_clear_all_for_user_cache( $user_id );
     }
 }
 add_action( 'bp_notification_before_delete', 'bp_notifications_clear_all_for_user_cache_before_delete' );
+
+/**
+ * Invalidates 'all_for_user_' cache when updating.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @param array $update_args See BP_Notifications_Notification::update() for description.
+ * @param array $where_args  See BP_Notifications_Notification::update() for description.
+ */
+function bp_notifications_clear_all_for_user_cache_before_update( $update_args, $where_args ) {
+
+    // User ID is passed in where arugments
+    if ( ! empty( $where_args['user_id'] ) ) {
+        bp_notifications_clear_all_for_user_cache( $where_args['user_id'] );
+
+    // Get user ID from Notification ID
+    } elseif ( ! empty( $where_args['id'] ) ) {
+        $n = bp_notifications_get_notification( $where_args['id'] );
+        bp_notifications_clear_all_for_user_cache( $n->user_id );
+    }
+}
+add_action( 'bp_notification_before_update', 'bp_notifications_clear_all_for_user_cache_before_update', 10, 2 );

trunk/src/bp-notifications/classes/class-bp-notifications-notification.php

@@ -831 +831 @@
         $where  = self::get_query_clauses( $where_args  );
 
-        // make sure we delete the notification cache for the user on update
-        if ( ! empty( $where_args['user_id'] ) ) {
-            wp_cache_delete( 'all_for_user_' . $where_args['user_id'], 'bp_notifications' );
-        }
-
-        return self::_update( $update['data'], $where['data'], $update['format'], $where['format'] );
+        /**
+         * Fires before the update of a notification item.
+         *
+         * @since BuddyPress (2.3.0)
+         *
+         * @param array $update_args See BP_Notifications_Notification::update().
+         * @param array $where_args  See BP_Notifications_Notification::update().
+         */
+        do_action( 'bp_notification_before_update', $update_args, $where_args );
+
+        return self::_update(
+            $update['data'],
+            $where['data'],
+            $update['format'],
+            $where['format']
+        );
     }