Changeset 6425 for trunk/src/includes/forums/capabilities.php

Timestamp:

05/26/2017 09:14:15 PM (6 years ago)

Author:

johnjamesjacoby

Message:

Users: Introduce bbp_allow_forums_of_user().

This filter-only function will be used to remove private & hidden forums from being excluded in queries, for users who are explicitly allowed forums that they would not otherwise be able to access.

See #2593.

File:

• trunk/src/includes/forums/capabilities.php (modified) (1 diff)

trunk/src/includes/forums/capabilities.php

@@ -258 +258 @@
     return (bool) apply_filters( 'bbp_is_user_forum_moderator', $retval, $user_id, $forum_id );
 }
+
+/**
+ * Filter an array of forum IDs that are being excluded, and remove any forum
+ * IDs a user explicitly has access to.
+ *
+ * This typically means private or hidden forums the user has moderation rights
+ * to, but it can be filtered to mean just about anything.
+ *
+ * This function filters the return values of the following functions:
+ * - `bbp_get_private_forum_ids()`
+ * - `bbp_get_hidden_forum_ids()`
+ *
+ * @since 2.6.0 bbPress (r6422)
+ *
+ * @param array $forum_ids Forum IDs to check if the user ID is a moderator of
+ * @param int   $user_id   User ID to check if is a moderator of forums
+ *
+ * @return array
+ */
+function bbp_allow_forums_of_user( $forum_ids = array(), $user_id = 0 ) {
+
+    // Store the original forum IDs
+    $original_forum_ids = $forum_ids;
+
+    // Per-forum Moderators
+    if ( bbp_allow_forum_mods() ) {
+
+        // Loop through forum IDs
+        foreach ( $forum_ids as $key => $forum_id ) {
+
+            // Unset forum ID if user is a moderator
+            if ( bbp_is_user_forum_moderator( $user_id, $forum_id ) ) {
+                unset( $forum_ids[ $key ] );
+            }
+        }
+    }
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_allow_forums_of_user', $forum_ids, $user_id, $original_forum_ids );
+}