Changeset 9352 for trunk/src/bp-notifications/bp-notifications-classes.php

Timestamp:

01/13/2015 01:35:21 AM (12 years ago)

Author:

tw2113

Message:

Adds hooks documentation to the BP-Notifications component.

Fixes #5946.

File:

• trunk/src/bp-notifications/bp-notifications-classes.php (modified) (3 diffs)

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

@@ -139 +139 @@
                 $data_format = array( '%d', '%d', '%d', '%s', '%s', '%s', '%d' );
 
+                /**
+                 * Fires before the current notification item gets saved.
+                 *
+                 * Please use this hook to filter the properties above. Each part will be passed in.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param BP_Notifications_Notification Current instance of the notification item being saved. Passed by reference.
+                 */
                 do_action_ref_array( 'bp_notification_before_save', array( &$this ) );
 
@@ -158 +167 @@
                 }
 
+                /**
+                 * Fires after the current notification item gets saved.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param BP_Notifications_Notification Current instance of the notification item being saved. Passed by reference.
+                 */
                 do_action_ref_array( 'bp_notification_after_save', array( &$this ) );
 
@@ -704 +720 @@
                 $where = self::get_query_clauses( $args );
 
+                /**
+                 * Fires before the deletion of a notification item.
+                 *
+                 * @since BuddyPress (2.0.0)
+                 *
+                 * @param array $args Associative array of columns/values, to determine
+                 *                    which rows should be deleted. Of the format
+                 *                    array( 'item_id' => 7, 'component_action' => 'members' ).
+                 */
                 do_action( 'bp_notification_before_delete', $args );