Changeset 5156 for trunk/includes/forums/functions.php

Timestamp:

11/20/2013 07:50:55 PM (10 years ago)

Author:

johnjamesjacoby

Message:

Forum Subscriptions - Allow users to subscribe to new topics in specific forums.

• Code largely lifted from existing Topics Subscriptions, and is based largely on forum-subscriptions.2.diff from mordauk, with edits for code consistency across bbPress components.
• Refactor existing ambiguous function names into base functions for both forum and topic subscriptions.
• Include new functions for getting and outputting subscriptions.
• Modify user-subscriptions.php to show subscribed forums. This includes a modification to content-single-forum.php to include the "Unsubscribe" link if looking at a user profile page.
• Modify templates/default/bbpress-functions.php to enqueue new JS file to handle forum subscription ajax.
• Rename HTML element classes from bbp-topic-action to bbp-row-actions to better accommodate forum subscriptions (and any future actions.)
• BuddyPress tested, JJJ approved.
• See #2299. Props mordauk, netweb for the considerable effort.
• More to do here, largely from forum-subscriptions.3.diff

File:

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

trunk/includes/forums/functions.php

@@ -962 +962 @@
 }
 
+/** Subscriptions *************************************************************/
+
+/**
+ * Remove a deleted forum from all users' subscriptions
+ *
+ * @since bbPress (rxxxx)
+ *
+ * @param int $forum_id Get the forum ID to remove
+ * @uses bbp_is_subscriptions_active() To check if the subscriptions are active
+ * @uses bbp_get_forum_id To get the forum id
+ * @uses bbp_get_forum_subscribers() To get the forum subscribers
+ * @uses bbp_remove_user_subscription() To remove the user subscription
+ */
+function bbp_remove_forum_from_all_subscriptions( $forum_id = 0 ) {
+
+    // Subscriptions are not active
+    if ( ! bbp_is_subscriptions_active() ) {
+        return;
+    }
+
+    $forum_id = bbp_get_forum_id( $forum_id );
+
+    // Bail if no forum
+    if ( empty( $forum_id ) ) {
+        return;
+    }
+
+    // Get users
+    $users = (array) bbp_get_forum_subscribers( $forum_id );
+
+    // Users exist
+    if ( !empty( $users ) ) {
+
+        // Loop through users
+        foreach ( $users as $user ) {
+
+            // Remove each user
+            bbp_remove_user_subscription( $user, $forum_id );
+        }
+    }
+}
+
 /** Count Bumpers *************************************************************/