Changeset 13091 for trunk/src/bp-notifications/bp-notifications-functions.php

Timestamp:

08/23/2021 02:03:02 AM (2 years ago)

Author:

espellcaste

Message:

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

See #8553

File:

• trunk/src/bp-notifications/bp-notifications-functions.php (modified) (10 diffs)

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

@@ -30 +30 @@
  *     @type string $date_notified     Timestamp for the notification.
  * }
- * @return int|bool ID of the newly created notification on success, false
- *                  on failure.
+ * @return int|bool ID of the newly created notification on success, false on failure.
  */
 function bp_notifications_add_notification( $args = array() ) {
@@ -96 +95 @@
  *
  * @param int $id ID of the notification to delete.
- * @return false|int True on success, false on failure.
+ * @return false|int Integer on success, false on failure.
  */
 function bp_notifications_delete_notification( $id ) {
@@ -115 +114 @@
  * @param int      $id     ID of the notification.
  * @param int|bool $is_new 0 for read, 1 for unread.
- * @return false|int True on success, false on failure.
+ * @return false|int Number of rows updated on success, false on failure.
  */
 function bp_notifications_mark_notification( $id, $is_new = false ) {
@@ -147 +146 @@
     if ( false === $notifications ) {
         $notifications = BP_Notifications_Notification::get( array(
-            'user_id' => $user_id
+            'user_id' => $user_id,
         ) );
         wp_cache_set( 'all_for_user_' . $user_id, $notifications, 'bp_notifications' );
@@ -483 +482 @@
     return BP_Notifications_Notification::update(
         array(
-            'is_new' => $is_new
+            'is_new' => $is_new,
         ),
         array(
             'user_id'          => $user_id,
             'component_name'   => $component_name,
-            'component_action' => $component_action
+            'component_action' => $component_action,
         )
     );
@@ -512 +511 @@
     return BP_Notifications_Notification::update(
         array(
-            'is_new' => $is_new
+            'is_new' => $is_new,
         ),
         array(
@@ -519 +518 @@
             'secondary_item_id' => $secondary_item_id,
             'component_name'    => $component_name,
-            'component_action'  => $component_action
+            'component_action'  => $component_action,
         )
     );
@@ -541 +540 @@
     return BP_Notifications_Notification::update(
         array(
-            'is_new' => $is_new
+            'is_new' => $is_new,
         ),
         array(
@@ -547 +546 @@
             'secondary_item_id' => $secondary_item_id,
             'component_name'    => $component_name,
-            'component_action'  => $component_action
+            'component_action'  => $component_action,
         )
     );
@@ -572 +571 @@
     return BP_Notifications_Notification::update(
         array(
-            'is_new' => $is_new
+            'is_new' => $is_new,
         ),
         array(
             'item_id'          => $user_id,
             'component_name'   => $component_name,
-            'component_action' => $component_action
+            'component_action' => $component_action,
         )
     );