Changeset 5906 for trunk/bp-friends/bp-friends-template.php

Timestamp:

03/11/2012 04:39:44 PM (13 years ago)

Author:

boonebgorges

Message:

Reworks some functions around the querying of friendship requests:

• Refactors bp_get_friendship_requests() so that it accepts a manual user_id parameter, and so that it falls back on the displayed_user rather than the loggedin_user (for future administrative tasks)
• Reconfigures the return value of bp_get_friendship_requests() so that a 0 is returned when there are no pending requests, to ensure that a non-false value is passed to bp_has_members() when viewing the Requests page of a user with no pending requests
• Removes the hardcoded 'return false' from bp_has_members() that would occur when an empty 'include' parameter was passed on the Requests page, so that sidebar widgets using bp_has_members() would work properly
• Reconfigures the 'include' logic in BP_Core_User::get_users() so that a value of 0 or '0' results in a false result, while continuing to respect legacy behavior of the default false value
• Fixes #4066

File:

• trunk/bp-friends/bp-friends-template.php (modified) (1 diff)

trunk/bp-friends/bp-friends-template.php

@@ -379 +379 @@
     return implode( ',', friends_get_friend_user_ids( $user_id ) );
 }
-function bp_get_friendship_requests() {
-    return apply_filters( 'bp_get_friendship_requests', implode( ',', (array) friends_get_friendship_request_user_ids( bp_loggedin_user_id() ) ) );
+
+/**
+ * Get a user's friendship requests
+ *
+ * Note that we return a 0 if no pending requests are found. This is necessary because of the
+ * structure of the $include parameter in bp_has_members().
+ *
+ * @param int $user_id Defaults to displayed user
+ * @return mixed Returns an array of users if found, or a 0 if none are found
+ */
+function bp_get_friendship_requests( $user_id = 0 ) {
+    if ( !$user_id ) {
+        $user_id = bp_displayed_user_id();
+    }
+    
+    if ( !$user_id ) {
+        return 0;   
+    }
+    
+    $requests = friends_get_friendship_request_user_ids( $user_id );
+    
+    if ( !empty( $requests ) ) {
+        $requests = implode( ',', (array) $requests );
+    } else {
+        $requests = 0;
+    }
+    
+    return apply_filters( 'bp_get_friendship_requests', $requests );
 }