Changeset 12547 for trunk/src/bp-core/deprecated/1.9.php

Timestamp:

01/29/2020 09:43:16 PM (5 years ago)

Author:

imath

Message:

Core: fix PHP code standards & typos in inline comments

Props passoniate

Fixes #8225
Fixes #8226
Fixes #8227
Fixes #8228
Fixes #8229

File:

• trunk/src/bp-core/deprecated/1.9.php (modified) (11 diffs)

trunk/src/bp-core/deprecated/1.9.php

@@ -10 +10 @@
  */
 
-// Exit if accessed directly
+// Exit if accessed directly.
 defined( 'ABSPATH' ) || exit;
 
@@ -31 +31 @@
 function bp_core_add_notification( $item_id, $user_id, $component_name, $component_action, $secondary_item_id = 0, $date_notified = false, $is_new = 1 ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_add_notification()' );
 
-    // Notifications must always have a time
+    // Notifications must always have a time.
     if ( false === $date_notified ) {
         $date_notified = bp_core_current_time();
     }
 
-    // Add the notification
+    // Add the notification.
     return bp_notifications_add_notification( array(
         'item_id'           => $item_id,
@@ -69 +69 @@
 function bp_core_delete_notification( $id ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notification()' );
 
@@ -92 +92 @@
 function bp_core_get_notification( $id ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_get_notification()' );
 
@@ -116 +116 @@
 function bp_core_get_notifications_for_user( $user_id, $format = 'string' ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_get_notifications_for_user()' );
 
@@ -146 +146 @@
 function bp_core_delete_notifications_by_type( $user_id, $component_name, $component_action ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_by_type()' );
 
@@ -175 +175 @@
 function bp_core_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_by_item_id()' );
 
@@ -201 +201 @@
 function bp_core_delete_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_all_notifications_by_type()' );
 
@@ -215 +215 @@
  * Delete all notifications for a user.
  *
- * Used when clearing out all notifications for a user, when deleted or spammed
+ * Used when clearing out all notifications for a user, when deleted or spammed.
  *
  * @deprecated Deprecated since BuddyPress 1.9.0. Use
@@ -228 +228 @@
 function bp_core_delete_notifications_from_user( $user_id, $component_name, $component_action ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_delete_notifications_from_user()' );
 
@@ -256 +256 @@
 function bp_core_check_notification_access( $user_id, $notification_id ) {
 
-    // Bail if notifications is not active
-    if ( ! bp_is_active( 'notifications' ) ) {
-        return false;
-    }
-
-    // Trigger the deprecated function notice
+    // Bail if notifications is not active.
+    if ( ! bp_is_active( 'notifications' ) ) {
+        return false;
+    }
+
+    // Trigger the deprecated function notice.
     _deprecated_function( __FUNCTION__, '1.9', 'bp_notifications_check_notification_access()' );