Changeset 7531

Timestamp:

11/08/2013 05:30:50 AM (11 years ago)

Author:

johnjamesjacoby

Message:

Introduce bp_core_mark_notifications_from_user() for completeness, though it's currently unused. Also fix some phpdoc. See #5148.

File:

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

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

@@ -165 +165 @@
 }
 
+/**
+ * Delete all notifications for a user
+ *
+ * Used when clearing out all notifications for a user, whene deleted or spammed
+ *
+ * @since BuddyPress (1.0)
+ * @param int $user_id
+ * @param string $component_name
+ * @param string $component_action
+ * @return boolean True on success, false on fail
+ */
+function bp_core_delete_notifications_from_user( $user_id, $component_name, $component_action ) {
+
+    // Bail if notifications is not active
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    return bp_notifications_delete_notifications_from_user( $user_id, $component_name, $component_action );
+}
+
 /** Mark **********************************************************************/
 
@@ -173 +194 @@
  * has visited that component.
  *
- * @since BuddyPress (1.0)
+ * @since BuddyPress (1.9.0)
  * @param int $user_id
  * @param string $component_name
@@ -196 +217 @@
  * has visited that component.
  *
- * @since BuddyPress (1.0)
+ * @since BuddyPress (1.9.0)
  * @param int $user_id
  * @param string $component_name
@@ -218 +239 @@
  * Used when clearing out notifications for an entire component
  *
- * @since BuddyPress (1.9)
+ * @since BuddyPress (1.9.0)
  * @param int $user_id
  * @param string $component_name
@@ -235 +256 @@
 
 /**
- * Delete all notifications for a user
- *
- * Used when clearing out all notifications for a user, whene deleted or spammed
- *
- * @since BuddyPress (1.0)
- * @param int $user_id
- * @param string $component_name
- * @param string $component_action
- * @return boolean True on success, false on fail
- */
-function bp_core_delete_notifications_from_user( $user_id, $component_name, $component_action ) {
-
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    return bp_notifications_delete_notifications_from_user( $user_id, $component_name, $component_action );
-}
+ * Mark all notifications read/unread from a user
+ *
+ * @since BuddyPress (1.9.0)
+ * @param int $user_id
+ * @param string $component_name
+ * @param string $component_action
+ * @return boolean True on success, false on fail
+ */
+function bp_core_mark_notifications_from_user( $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_from_user( $user_id, $component_name, $component_action, $is_new );
+}
+
+/** Helpers *******************************************************************/
 
 /**