Changeset 7530 for trunk/bp-members/bp-members-notifications.php

Timestamp:

11/08/2013 05:20:46 AM (11 years ago)

Author:

johnjamesjacoby

Message:

Introduce bp_core_mark_notifications_by_type() and bp_core_mark_notifications_by_item_id() and replace bp_core_delete_notifications_by_type() and bp_core_delete_notifications_by_item_id() usages.

Ensures notifications are toggled as acknowledged rather than deleted. See #5148.

File:

• trunk/bp-members/bp-members-notifications.php (modified) (2 diffs)

trunk/bp-members/bp-members-notifications.php

@@ -100 +100 @@
 }
 
+/** Delete ********************************************************************/
+
 /**
  * Delete notifications for a user by type
@@ -163 +165 @@
 }
 
+/** Mark **********************************************************************/
+
+/**
+ * Delete notifications for a user by type
+ *
+ * Used when clearing out notifications for a specific component when the user
+ * has visited that component.
+ *
+ * @since BuddyPress (1.0)
+ * @param int $user_id
+ * @param string $component_name
+ * @param string $component_action
+ * @param int $is_new
+ * @return boolean True on success, false on fail
+ */
+function bp_core_mark_notifications_by_type( $user_id, $component_name, $component_action, $is_new = false ) {
+
+    // Bail if notifications is not active
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    return bp_notifications_mark_notifications_by_type( $user_id, $component_name, $component_action, $is_new );
+}
+
+/**
+ * Delete notifications for an item ID
+ *
+ * Used when clearing out notifications for a specific component when the user
+ * has visited that component.
+ *
+ * @since BuddyPress (1.0)
+ * @param int $user_id
+ * @param string $component_name
+ * @param string $component_action
+ * @param int $is_new
+ * @return boolean True on success, false on fail
+ */
+function bp_core_mark_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false, $is_new = false ) {
+
+    // Bail if notifications is not active
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    return bp_notifications_mark_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id, $is_new );
+}
+
 /**
  * Mark all notifications read/unread for by type