Changeset 3504 for branches/plugin/bbp-includes/bbp-user-functions.php

Timestamp:

09/10/2011 07:30:45 PM (13 years ago)

Author:

johnjamesjacoby

Message:

Introduce bbp_is_user_active() and bbp_is_user_inactive() to help with spammed and deleted user checks. See #1630 and r3503.

File:

• branches/plugin/bbp-includes/bbp-user-functions.php (modified) (1 diff)

branches/plugin/bbp-includes/bbp-user-functions.php

@@ -1186 +1186 @@
 }
 
+/**
+ * Checks if user is active
+ * 
+ * @since bbPress (r3502)
+ * 
+ * @uses is_user_logged_in() To check if user is logged in
+ * @uses bbp_get_displayed_user_id() To get current user ID
+ * @uses bbp_is_user_spammer() To check if user is spammer
+ * @uses bbp_is_user_deleted() To check if user is deleted
+ *
+ * @param int $user_id The user ID to check
+ * @return bool True if public, false if not
+ */
+function bbp_is_user_active( $user_id = 0 ) {
+
+    // Default to current user
+    if ( empty( $user_id ) && is_user_logged_in() )
+        $user_id = bbp_get_current_user_id();
+
+    // No user to check
+    if ( empty( $user_id ) )
+        return false;
+
+    // Check spam
+    if ( bbp_is_user_spammer( $user_id ) )
+        return false;
+
+    // Check deleted
+    if ( bbp_is_user_deleted( $user_id ) )
+        return false;
+
+    // Assume true if not spam or deleted
+    return true;
+}
+
+/**
+ * Checks if user is not active.
+ * 
+ * @since bbPress (r3502)
+ * 
+ * @uses is_user_logged_in() To check if user is logged in
+ * @uses bbp_get_displayed_user_id() To get current user ID
+ * @uses bbp_is_user_active() To check if user is active
+ *
+ * @param int $user_id The user ID to check
+ * @return bool True if inactive, false if active
+ */
+function bbp_is_user_inactive( $user_id = 0 ) {
+
+    // Default to current user
+    if ( empty( $user_id ) && is_user_logged_in() )
+        $user_id = bbp_get_current_user_id();
+
+    // No user to check
+    if ( empty( $user_id ) )
+        return false;
+
+    // Return the inverse of active
+    return !bbp_is_user_active( $user_id );
+}
+
 ?>