Changeset 10304 for trunk/src/bp-messages/bp-messages-notifications.php

Timestamp:

10/22/2015 06:12:16 AM (11 years ago)

Author:

tw2113

Message:

Second pass at Messages Component docs cleanup.

See #6403.

File:

• trunk/src/bp-messages/bp-messages-notifications.php (modified) (9 diffs)

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

@@ -27 +27 @@
 function messages_notification_new_message( $raw_args = array() ) {
 
-        // Cast possible $message object as an array
+        // Cast possible $message object as an array.
         if ( is_object( $raw_args ) ) {
                 $args = (array) $raw_args;
@@ -34 +34 @@
         }
 
-        // These should be extracted below
+        // These should be extracted below.
         $recipients    = array();
         $email_subject = $email_content = '';
         $sender_id     = 0;
 
-        // Barf
+        // Barf.
         extract( $args );
 
-        // Get the sender display name
+        // Get the sender display name.
         $sender_name = bp_core_get_user_displayname( $sender_id );
 
-        // Bail if no recipients
+        // Bail if no recipients.
         if ( ! empty( $recipients ) ) {
 
@@ -54 +54 @@
                         }
 
-                        // User data and links
+                        // User data and links.
                         $ud = get_userdata( $recipient->user_id );
 
-                        // Bail if user cannot be found
+                        // Bail if user cannot be found.
                         if ( empty( $ud ) ) {
                                 continue;
@@ -66 +66 @@
                         $settings_link = bp_core_get_user_domain( $recipient->user_id ) . $settings_slug . '/notifications/';
 
-                        // Sender info
+                        // Sender info.
                         $sender_name   = stripslashes( $sender_name );
                         $subject       = stripslashes( wp_filter_kses( $subject ) );
                         $content       = stripslashes( wp_filter_kses( $message ) );
 
-                        // Set up and send the message
+                        // Set up and send the message.
                         $email_to      = $ud->user_email;
                         $email_subject = bp_get_email_subject( array( 'text' => sprintf( __( 'New message from %s', 'buddypress' ), $sender_name ) ) );
@@ -87 +87 @@
 ', 'buddypress' ), $sender_name, $subject, $content, $message_link );
 
-                        // Only show the disable notifications line if the settings component is enabled
+                        // Only show the disable notifications line if the settings component is enabled.
                         if ( bp_is_active( 'settings' ) ) {
                                 $email_content .= sprintf( __( 'To disable these notifications, please log in and go to: %s', 'buddypress' ), $settings_link );
@@ -160 +160 @@
  * @param string $format            Return value format. 'string' for BuddyBar-compatible
  *                                  notifications; 'array' for WP Toolbar. Default: 'string'.
- *
  * @return string|array Formatted notifications.
  */
@@ -176 +175 @@
                         $amount = 'single';
 
-                        // get message thread ID
+                        // Get message thread ID.
                         $message   = new BP_Messages_Message( $item_id );
                         $thread_id = $message->thread_id;
@@ -268 +267 @@
                 global $thread_template;
 
-                // get unread PM notifications for the user
+                // Get unread PM notifications for the user.
                 $new_pm_notifications = BP_Notifications_Notification::get( array(
                         'user_id'           => bp_loggedin_user_id(),
@@ -277 +276 @@
                 $unread_message_ids = wp_list_pluck( $new_pm_notifications, 'item_id' );
 
-                // no unread PMs, so stop!
+                // No unread PMs, so stop!
                 if ( empty( $unread_message_ids ) ) {
                         return;
                 }
 
-                // get the unread message ids for this thread only
+                // Get the unread message ids for this thread only.
                 $message_ids = array_intersect( $unread_message_ids, wp_list_pluck( $thread_template->thread->messages, 'id' ) );
 
-                // mark each notification for each PM message as read
+                // Mark each notification for each PM message as read.
                 foreach ( $message_ids as $message_id ) {
                         bp_notifications_mark_notifications_by_item_id( bp_loggedin_user_id(), (int) $message_id, buddypress()->messages->id, 'new_message' );