Changeset 6438 for trunk/src/includes/users/functions.php

Timestamp:

05/27/2017 05:04:31 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Tools: Add //Filter & return note for future discovery of missing filter documentation.

Also adjust some type-casting on filtered results.

File:

• trunk/src/includes/users/functions.php (modified) (12 diffs)

trunk/src/includes/users/functions.php

@@ -40 +40 @@
     }
 
+    // Filter & return
     return apply_filters( 'bbp_redirect_login', $url, $raw_url, $user );
 }
@@ -55 +56 @@
  */
 function bbp_is_anonymous() {
-    if ( ! is_user_logged_in() && bbp_allow_anonymous() ) {
-        $is_anonymous = true;
-    } else {
-        $is_anonymous = false;
-    }
-
-    return apply_filters( 'bbp_is_anonymous', $is_anonymous );
+    $is_anonymous = ( ! is_user_logged_in() && bbp_allow_anonymous() );
+
+    // Filter & return
+    return (bool) apply_filters( 'bbp_is_anonymous', $is_anonymous );
 }
 
@@ -167 +165 @@
     $retval = preg_replace( '/[^0-9a-fA-F:., ]/', '', $remote_address );
 
+    // Filter & return
     return apply_filters( 'bbp_current_author_ip', $retval, $remote_address );
 }
@@ -182 +181 @@
         : '';
 
+    // Filter & return
     return apply_filters( 'bbp_current_author_ua', $retval );
 }
@@ -553 +553 @@
     ) );
 
+    // Filter & return
     return apply_filters( 'bbp_get_user_topics_started', $query, $user_id );
 }
@@ -581 +582 @@
     ) );
 
+    // Filter & return
     return apply_filters( 'bbp_get_user_replies_created', $query, $user_id );
 }
@@ -595 +597 @@
 function bbp_get_total_users() {
     $user_count = count_users();
-    return apply_filters( 'bbp_get_total_users', (int) $user_count['total_users'] );
+
+    // Filter & return
+    return (int) apply_filters( 'bbp_get_total_users', (int) $user_count['total_users'] );
 }
 
@@ -632 +636 @@
     }
 
-    return apply_filters( 'bbp_get_user_ids_from_nicenames', $retval, $user_nicenames );
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_user_ids_from_nicenames', $retval, $user_nicenames );
 }
 
@@ -664 +669 @@
     }
 
-    return apply_filters( 'bbp_get_user_nicenames_from_ids', $retval, $user_ids );
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_user_nicenames_from_ids', $retval, $user_ids );
 }
 
@@ -693 +699 @@
     $count = $count + bbp_get_user_closed_topic_count( $user_id );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_get_user_topic_count_raw', $count, $user_id );
 }
@@ -718 +725 @@
     $count = count_user_posts( $user_id, bbp_get_reply_post_type(), false );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_get_user_reply_count_raw', $count, $user_id );
 }
@@ -748 +756 @@
     ) );
 
+    // Filter & return
     return (int) apply_filters( 'bbp_get_user_closed_topic_count', $count, $user_id );
 }