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

Timestamp:

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

Author:

tw2113

Message:

Add hook documentation for the Messages component.

Fixes #5945

File:

• trunk/src/bp-messages/bp-messages-classes.php (modified) (6 diffs)

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

@@ -269 +269 @@
         // No more recipients so delete all messages associated with the thread
         if ( empty( $recipients ) ) {
+
             /**
              * Fires before an entire message thread is deleted.
@@ -732 +733 @@
         $this->date_sent = apply_filters( 'messages_message_date_sent_before_save', $this->date_sent, $this->id );
 
+        /**
+         * Fires before the current message item gets saved.
+         *
+         * Please use this hook to filter the properties above. Each part will be passed in.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param BP_Messages_Message Current instance of the message item being saved. Passed by reference.
+         */
         do_action_ref_array( 'messages_message_before_save', array( &$this ) );
 
@@ -771 +781 @@
         messages_remove_callback_values();
 
+        /**
+         * Fires after the current message item has been saved.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param BP_Messages_Message Current instance of the message item being saved. Passed by reference.
+         */
         do_action_ref_array( 'messages_message_after_save', array( &$this ) );
 
@@ -934 +951 @@
         $this->message = apply_filters( 'messages_notice_message_before_save', $this->message, $this->id );
 
+        /**
+         * Fires before the current message notice item gets saved.
+         *
+         * Please use this hook to filter the properties above. Each part will be passed in.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param BP_Messages_Notice Current instance of the message notice item being saved. Passed by reference.
+         */
         do_action_ref_array( 'messages_notice_before_save', array( &$this ) );
 
@@ -955 +981 @@
         bp_update_user_last_activity( bp_loggedin_user_id(), bp_core_current_time() );
 
+        /**
+         * Fires after the current message notice item has been saved.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param BP_Messages_Notice Current instance of the message item being saved. Passed by reference.
+         */
         do_action_ref_array( 'messages_notice_after_save', array( &$this ) );
 
@@ -994 +1027 @@
         global $wpdb, $bp;
 
+        /**
+         * Fires before the current message item has been deleted.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param BP_Messages_Notice Current instance of the message notice item being deleted.
+         */
         do_action( 'messages_notice_before_delete', $this );