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

Timestamp:

08/26/2021 12:53:27 AM (5 years ago)

Author:

espellcaste

Message:

Making PHPDoc Improvements to the BP Messages (component) files.

Also, adding several minor PHP changes.

See #8553

File:

• trunk/src/bp-messages/bp-messages-functions.php (modified) (7 diffs)

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

@@ -212 +212 @@
  */
 function messages_send_notice( $subject, $message ) {
-        if ( !bp_current_user_can( 'bp_moderate' ) || empty( $subject ) || empty( $message ) ) {
+
+        if ( ! bp_current_user_can( 'bp_moderate' ) || empty( $subject ) || empty( $message ) ) {
                 return false;
-
-        // Has access to send notices, lets do it.
-        } else {
-                $notice            = new BP_Messages_Notice;
-                $notice->subject   = $subject;
-                $notice->message   = $message;
-                $notice->date_sent = bp_core_current_time();
-                $notice->is_active = 1;
-                $notice->save(); // Send it.
-
-                /**
-                 * Fires after a notice has been successfully sent.
-                 *
-                 * @since 1.0.0
-                 *
-                 * @param string $subject Subject of the notice.
-                 * @param string $message Content of the notice.
-                 */
-                do_action_ref_array( 'messages_send_notice', array( $subject, $message ) );
-
-                return true;
-        }
+        }
+
+        $notice            = new BP_Messages_Notice;
+        $notice->subject   = $subject;
+        $notice->message   = $message;
+        $notice->date_sent = bp_core_current_time();
+        $notice->is_active = 1;
+        $notice->save(); // Send it.
+
+        /**
+         * Fires after a notice has been successfully sent.
+         *
+         * @since 1.0.0
+         *
+         * @param string             $subject Subject of the notice.
+         * @param string             $message Content of the notice.
+         * @param BP_Messages_Notice $notice  Notice object sent.
+         */
+        do_action_ref_array( 'messages_send_notice', array( $subject, $message, $notice ) );
+
+        return true;
 }
 
@@ -276 +276 @@
                 $error = 0;
                 for ( $i = 0, $count = count( $thread_ids ); $i < $count; ++$i ) {
-                        if ( ! BP_Messages_Thread::delete( $thread_ids[$i], $user_id ) ) {
+                        if ( ! BP_Messages_Thread::delete( $thread_ids[ $i ], $user_id ) ) {
                                 $error = 1;
                         }
@@ -427 +427 @@
  * @since 2.3.0
  *
+ * @global BuddyPress $bp The one true BuddyPress instance.
+ * @global wpdb $wpdb WordPress database object.
+ *
  * @param  int $message_id ID of the message.
  * @return int The ID of the thread if found, otherwise 0.
@@ -446 +449 @@
  *
  * @since 2.2.0
+ *
+ * @global wpdb $wpdb WordPress database object.
  *
  * @see delete_metadata() for full documentation excluding $meta_type variable.
@@ -579 +584 @@
 
         // These should be extracted below.
-        $recipients    = array();
-        $email_subject = $email_content = '';
-        $sender_id     = 0;
+        $recipients = array();
+        $sender_id  = 0;
 
         // Barf.
@@ -666 +670 @@
                 );
         }
-
-        $user_data_to_export = array();
 
         $user_threads = BP_Messages_Thread::get_current_threads_for_user( array(
@@ -717 +719 @@
                                 ),
                                 array(
-                                        'name' => __( 'Recipients', 'buddypress' ),
+                                        'name'  => __( 'Recipients', 'buddypress' ),
                                         'value' => $recipients,
                                 ),