Ticket #5945: bp-messages-screens-5945.diff

src/bp-messages/bp-messages-screens.php

@@ -23 +23 @@
                 return;
         }
 
+        /**
+         * Fires right before the loading of the Messages inbox screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         */
         do_action( 'messages_screen_inbox' );
+
+        /**
+         * Filters the template to load for the Messages inbox screen.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $template Path to the messages template to load.
+         */
         bp_core_load_template( apply_filters( 'messages_template_inbox', 'members/single/home' ) );
 }
 
@@ -36 +49 @@
                 return;
         }
 
+        /**
+         * Fires right before the loading of the Messages sentbox screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         */
         do_action( 'messages_screen_sentbox' );
+
+        /**
+         * Filters the template to load for the Messages sentbox screen.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $template Path to the messages template to load.
+         */
         bp_core_load_template( apply_filters( 'messages_template_sentbox', 'members/single/home' ) );
 }
 
@@ -76 +102 @@
                                 $autocomplete_recipients = explode( ',', $_POST['send-to-input'] );
                                 $typed_recipients        = explode( ' ', $_POST['send_to_usernames'] );
                                 $recipients              = array_merge( (array) $autocomplete_recipients, (array) $typed_recipients );
+
+                                /**
+                                 * Filters the array of recipients to receive the composed message.
+                                 *
+                                 * @since BuddyPress (1.2.10)
+                                 *
+                                 * @param array $recipients Array of recipients to receive message.
+                                 */
                                 $recipients              = apply_filters( 'bp_messages_recipients', $recipients );
                                 $thread_id               = messages_new_message( array(
                                         'recipients' => $recipients,
@@ -94 +128 @@
                 }
         }
 
+        /**
+         * Fires right before the loading of the Messages compose screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         */
         do_action( 'messages_screen_compose' );
 
+        /**
+         * Filters the template to load for the Messages compose screen.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $template Path to the messages template to load.
+         */
         bp_core_load_template( apply_filters( 'messages_template_compose', 'members/single/home' ) );
 }
 
@@ -123 +169 @@
         // Decrease the unread count in the nav before it's rendered
         $bp->bp_nav[$bp->messages->slug]['name'] = sprintf( __( 'Messages <span>%s</span>', 'buddypress' ), bp_get_total_unread_messages_count() );
 
+        /**
+         * Fires right before the loading of the Messages view screen template file.
+         *
+         * @since BuddyPress (1.7.0)
+         */
         do_action( 'messages_screen_conversation' );
 
+        /**
+         * Filters the template to load for the Messages view screen.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $template Path to the messages template to load.
+         */
         bp_core_load_template( apply_filters( 'messages_template_view_message', 'members/single/home' ) );
 }
 add_action( 'bp_screens', 'messages_screen_conversation' );
@@ -173 +231 @@
                 return;
         }
 
+        /**
+         * Fires right before the loading of the Messages notices screen template file.
+         *
+         * @since BuddyPress (1.0.0)
+         */
         do_action( 'messages_screen_notices' );
 
+        /**
+         * Filters the template to load for the Messages notices screen.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param string $template Path to the messages template to load.
+         */
         bp_core_load_template( apply_filters( 'messages_template_notices', 'members/single/home' ) );
 }
 
@@ -209 +279 @@
                                 <td class="no"><input type="radio" name="notifications[notification_messages_new_message]" value="no" <?php checked( $new_messages, 'no', true ) ?>/></td>
                         </tr>
 
-                        <?php do_action( 'messages_screen_notification_settings' ) ?>
+                        <?php
+
+                        /**
+                         * Fires inside the closing </tbody> tag for messages screen notification settings.
+                         *
+                         * @since BuddyPress (1.0.0)
+                         */
+                        do_action( 'messages_screen_notification_settings' ); ?>
                 </tbody>
         </table>