Changeset 10303 for trunk/src/bp-notifications/bp-notifications-actions.php

Timestamp:

10/22/2015 06:02:55 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for Notifications component.

See #6404.

File:

• trunk/src/bp-notifications/bp-notifications-actions.php (modified) (8 diffs)

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

@@ -23 +23 @@
 function bp_notifications_action_mark_read() {
 
-    // Bail if not the unread screen
+    // Bail if not the unread screen.
     if ( ! bp_is_notifications_component() || ! bp_is_current_action( 'unread' ) ) {
         return false;
     }
 
-    // Get the action
+    // Get the action.
     $action = !empty( $_GET['action']          ) ? $_GET['action']          : '';
     $nonce  = !empty( $_GET['_wpnonce']        ) ? $_GET['_wpnonce']        : '';
     $id     = !empty( $_GET['notification_id'] ) ? $_GET['notification_id'] : '';
 
-    // Bail if no action or no ID
+    // Bail if no action or no ID.
     if ( ( 'read' !== $action ) || empty( $id ) || empty( $nonce ) ) {
         return false;
     }
 
-    // Check the nonce and mark the notification
+    // Check the nonce and mark the notification.
     if ( bp_verify_nonce_request( 'bp_notification_mark_read_' . $id ) && bp_notifications_mark_notification( $id, false ) ) {
         bp_core_add_message( __( 'Notification successfully marked read.',         'buddypress' )          );
@@ -45 +45 @@
     }
 
-    // Redirect
+    // Redirect.
     bp_core_redirect( bp_displayed_user_domain() . bp_get_notifications_slug() . '/unread/' );
 }
@@ -59 +59 @@
 function bp_notifications_action_mark_unread() {
 
-    // Bail if not the read screen
+    // Bail if not the read screen.
     if ( ! bp_is_notifications_component() || ! bp_is_current_action( 'read' ) ) {
         return false;
     }
 
-    // Get the action
+    // Get the action.
     $action = !empty( $_GET['action']          ) ? $_GET['action']          : '';
     $nonce  = !empty( $_GET['_wpnonce']        ) ? $_GET['_wpnonce']        : '';
     $id     = !empty( $_GET['notification_id'] ) ? $_GET['notification_id'] : '';
 
-    // Bail if no action or no ID
+    // Bail if no action or no ID.
     if ( ( 'unread' !== $action ) || empty( $id ) || empty( $nonce ) ) {
         return false;
     }
 
-    // Check the nonce and mark the notification
+    // Check the nonce and mark the notification.
     if ( bp_verify_nonce_request( 'bp_notification_mark_unread_' . $id ) && bp_notifications_mark_notification( $id, true ) ) {
         bp_core_add_message( __( 'Notification successfully marked unread.',       'buddypress' )          );
@@ -81 +81 @@
     }
 
-    // Redirect
+    // Redirect.
     bp_core_redirect( bp_displayed_user_domain() . bp_get_notifications_slug() . '/read/' );
 }
@@ -95 +95 @@
 function bp_notifications_action_delete() {
 
-    // Bail if not the read or unread screen
+    // Bail if not the read or unread screen.
     if ( ! bp_is_notifications_component() || ! ( bp_is_current_action( 'read' ) || bp_is_current_action( 'unread' ) ) ) {
         return false;
     }
 
-    // Get the action
+    // Get the action.
     $action = !empty( $_GET['action']          ) ? $_GET['action']          : '';
     $nonce  = !empty( $_GET['_wpnonce']        ) ? $_GET['_wpnonce']        : '';
     $id     = !empty( $_GET['notification_id'] ) ? $_GET['notification_id'] : '';
 
-    // Bail if no action or no ID
+    // Bail if no action or no ID.
     if ( ( 'delete' !== $action ) || empty( $id ) || empty( $nonce ) ) {
         return false;
     }
 
-    // Check the nonce and delete the notification
+    // Check the nonce and delete the notification.
     if ( bp_verify_nonce_request( 'bp_notification_delete_' . $id ) && bp_notifications_delete_notification( $id ) ) {
         bp_core_add_message( __( 'Notification successfully deleted.',              'buddypress' )          );
@@ -117 +117 @@
     }
 
-    // Redirect
+    // Redirect.
     bp_core_redirect( bp_displayed_user_domain() . bp_get_notifications_slug() . '/' . bp_current_action() . '/' );
 }
@@ -136 +136 @@
     }
 
-    // Get the action
+    // Get the action.
     $action = !empty( $_POST['notification_bulk_action'] ) ? $_POST['notification_bulk_action'] : '';
     $nonce  = !empty( $_POST['notifications_bulk_nonce'] ) ? $_POST['notifications_bulk_nonce'] : '';
@@ -178 +178 @@
     }
 
-    // Redirect
+    // Redirect.
     bp_core_redirect( bp_displayed_user_domain() . bp_get_notifications_slug() . '/' . bp_current_action() . '/' );
 }