Changeset 12989 for trunk/src/bp-messages/bp-messages-functions.php

Timestamp:

07/08/2021 05:23:19 PM (4 years ago)

Author:

dcavins

Message:

Introduce bp_messages_dismiss_sitewide_notice().

Introduce bp_messages_dismiss_sitewide_notice()
as core function to dismiss a notice for a user.
This function allows us to replace code to update the
user's closed_notices meta that is repeated in
several places in BuddyPress.

See #8505.

File:

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

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

@@ -740 +740 @@
     );
 }
+
+/**
+ * Dismiss a sitewide notice for a user.
+ *
+ * @since 9.0.0
+ *
+ * @param int $user_id   ID of the user to dismiss the notice for.
+ *                       Defaults to the logged-in user.
+ * @param int $notice_id ID of the notice to be dismissed.
+ *                       Defaults to the currently active notice.
+ * @return bool False on failure, true if notice is dismissed
+ *              (or was already dismissed).
+ */
+function bp_messages_dismiss_sitewide_notice( $user_id = 0, $notice_id = 0 ) {
+    $retval = false;
+    if ( ! $user_id ) {
+        $user_id = bp_loggedin_user_id();
+    }
+
+    // Bail if no user is set.
+    if ( ! $user_id ) {
+        return $retval;
+    }
+
+    if ( $notice_id ) {
+        $notice = new BP_Messages_Notice( $notice_id );
+    } else {
+        $notice = BP_Messages_Notice::get_active();
+    }
+
+    // Bail if no notice is set.
+    if ( empty( $notice->id ) ) {
+        return $retval;
+    }
+
+    // Fetch the user's closed notices and add the new item.
+    $closed_notices = (array) bp_get_user_meta( $user_id, 'closed_notices', true );
+    $closed_notices = array_filter( $closed_notices );
+
+    if ( in_array( (int) $notice->id, $closed_notices, true ) ) {
+        // The notice has already been dismissed, so there's nothing to do.
+        $retval = true;
+    } else {
+        // Add the notice to the closed_notices meta.
+        $closed_notices[] = (int) $notice->id;
+        $closed_notices   = array_map( 'absint', array_unique( $closed_notices ) );
+        $success          = bp_update_user_meta( $user_id, 'closed_notices', $closed_notices );
+
+        // The return value from update_user_meta() could be an integer or a boolean.
+        $retval = (bool) $success;
+    }
+
+    return $retval;
+}