Changeset 13036

Timestamp:

08/10/2021 04:55:25 PM (3 years ago)

Author:

imath

Message:

BP Nouveau: include a notification to the active Site Wide Notice

When a Site Wide notice is active the BP Nouveau template pack is prepending a notification to the logged in user notifications list.

FYI: This feature was "missing in action" since the introduction of the bp_notifications_get_grouped_notifications_for_user() and its use inside the bp_notifications_get_notifications_for_user() function in replacement of bp_notifications_get_all_notifications_for_user().

Fixes #8547

Location:

trunk/src/bp-templates/bp-nouveau/includes/messages

Files:

• functions.php (modified) (3 diffs)
• loader.php (modified) (2 diffs)

trunk/src/bp-templates/bp-nouveau/includes/messages/functions.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 3.1.0
+ * @version 10.0.0
  */
 
@@ -191 +191 @@
 
 /**
- * @since 3.0.0
+ * Prepend a notification about the active Sitewide notice.
+ *
+ * @since 3.0.0
+ *
+ * @param false|array $notifications False if there are no items, an array of notification items otherwise.
+ * @param int         $user_id       The user ID.
+ * @return false|array               False if there are no items, an array of notification items otherwise.
  */
 function bp_nouveau_add_notice_notification_for_user( $notifications, $user_id ) {
@@ -212 +218 @@
     }
 
-    $notice_notification                    = new stdClass;
-    $notice_notification->id                = 0;
-    $notice_notification->user_id           = $user_id;
-    $notice_notification->item_id           = $notice->id;
-    $notice_notification->secondary_item_id = '';
-    $notice_notification->component_name    = 'messages';
-    $notice_notification->component_action  = 'new_notice';
-    $notice_notification->date_notified     = $notice->date_sent;
-    $notice_notification->is_new            = '1';
-
-    return array_merge( $notifications, array( $notice_notification ) );
-}
-
-/**
- * @since 3.0.0
+    $notice_notification = (object) array(
+        'id'                => 0,
+        'user_id'           => $user_id,
+        'item_id'           => $notice->id,
+        'secondary_item_id' => 0,
+        'component_name'    => 'messages',
+        'component_action'  => 'new_notice',
+        'date_notified'     => $notice->date_sent,
+        'is_new'            => 1,
+        'total_count'       => 1,
+        'content'           => __( 'New sitewide notice', 'buddypress' ),
+        'href'              => bp_loggedin_user_domain(),
+    );
+
+    if ( ! is_array( $notifications ) ) {
+        $notifications = array( $notice_notification );
+    } else {
+        array_unshift( $notifications, $notice_notification );
+    }
+
+    return $notifications;
+}
+
+/**
+ * Format the notice notifications.
+ *
+ * @since 3.0.0
+ * @deprecated 10.0.0
+ *
+ * @param array $array.
  */
 function bp_nouveau_format_notice_notification_for_user( $array ) {
-    if ( ! empty( $array['text'] ) || ! doing_action( 'admin_bar_menu' ) ) {
-        return $array;
-    }
-
-    return array(
-        'text' => __( 'New sitewide notice', 'buddypress' ),
-        'link' => bp_loggedin_user_domain(),
-    );
+    _deprecated_function( __FUNCTION__, '10.0.0' );
 }
 

trunk/src/bp-templates/bp-nouveau/includes/messages/loader.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 3.0.0
+ * @version 10.0.0
  */
 
@@ -89 +89 @@
      */
     protected function setup_filters() {
-        // Enqueue specific styles
+        // Enqueue specific styles.
         add_filter( 'bp_nouveau_enqueue_styles', 'bp_nouveau_messages_enqueue_styles', 10, 1 );
 
-        // Register messages scripts
+        // Register messages scripts.
         add_filter( 'bp_nouveau_register_scripts', 'bp_nouveau_messages_register_scripts', 10, 1 );
 
-        // Localize Scripts
+        // Localize Scripts.
         add_filter( 'bp_core_get_js_strings', 'bp_nouveau_messages_localize_scripts', 10, 1 );
 
-        // Notices
-        add_filter( 'bp_messages_single_new_message_notification', 'bp_nouveau_format_notice_notification_for_user', 10, 1 );
-        add_filter( 'bp_notifications_get_all_notifications_for_user', 'bp_nouveau_add_notice_notification_for_user', 10, 2 );
+        // Notices.
+        add_filter( 'bp_core_get_notifications_for_user', 'bp_nouveau_add_notice_notification_for_user', 10, 2 );
 
-        // Messages
+        // Messages.
         add_filter( 'bp_messages_admin_nav', 'bp_nouveau_messages_adjust_admin_nav', 10, 1 );
     }