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

Timestamp:

12/07/2014 12:27:30 AM (12 years ago)

Author:

tw2113

Message:

Add hook documentation for the Messages component.

Fixes #5945

File:

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

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

@@ -156 +156 @@
         }
 
-        // Allow additional actions when a message is sent successfully
+        /**
+         * Fires after a message has been successfully sent.
+         *
+         * @since BuddyPress (1.1.0)
+         *
+         * @param BP_Messages_Message $message Message object. Passed by reference.
+         */
         do_action_ref_array( 'messages_message_sent', array( &$message ) );
 
@@ -183 +189 @@
                 $notice->save(); // send it.
 
+                /**
+                 * Fires after a notice has been successfully sent.
+                 *
+                 * @since BuddyPress (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 ) );
 
@@ -196 +210 @@
  */
 function messages_delete_thread( $thread_ids ) {
+
+        /**
+         * Fires before specified thread IDs have been deleted.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param int|array Thread ID or array of thread IDs that were deleted.
+         */
         do_action( 'messages_before_delete_thread', $thread_ids );
 
@@ -210 +232 @@
                 }
 
+                /**
+                 * Fires after specified thread IDs have been deleted.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param int|array Thread ID or array of thread IDs that were deleted.
+                 */
                 do_action( 'messages_delete_thread', $thread_ids );
 
@@ -218 +247 @@
                 }
 
+                /** This action is documented in bp-messages/bp-messages-functions.php */
                 do_action( 'messages_delete_thread', $thread_ids );