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

Timestamp:

11/20/2013 07:50:55 PM (12 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/common/functions.php (modified) (4 diffs)

trunk/includes/common/functions.php

@@ -983 +983 @@
 
 /**
- * Sends notification emails for new posts
+ * Sends notification emails for new replies to subscribed topics
  *
  * Gets new post's ID and check if there are subscribed users to that topic, and
@@ -993 +993 @@
  * @uses bbp_is_subscriptions_active() To check if the subscriptions are active
  * @uses bbp_get_reply_id() To validate the reply ID
+ * @uses bbp_get_topic_id() To validate the topic ID
+ * @uses bbp_get_forum_id() To validate the forum ID
  * @uses bbp_get_reply() To get the reply
- * @uses bbp_get_reply_topic_id() To get the topic ID of the reply
  * @uses bbp_is_reply_published() To make sure the reply is published
  * @uses bbp_get_topic_id() To validate the topic ID
  * @uses bbp_get_topic() To get the reply's topic
  * @uses bbp_is_topic_published() To make sure the topic is published
- * @uses get_the_author_meta() To get the author's display name
- * @uses do_action() Calls 'bbp_pre_notify_subscribers' with the reply id and
- *                    topic id
+ * @uses bbp_get_reply_author_display_name() To get the reply author's display name
+ * @uses do_action() Calls 'bbp_pre_notify_subscribers' with the reply id,
+ *                    topic id and user id
  * @uses bbp_get_topic_subscribers() To get the topic subscribers
  * @uses apply_filters() Calls 'bbp_subscription_mail_message' with the
- *                        message, reply id, topic id and user id
+ *                    message, reply id, topic id and user id
+ * @uses apply_filters() Calls 'bbp_subscription_mail_title' with the
+ *                    topic title, reply id, topic id and user id
+ * @uses apply_filters() Calls 'bbp_subscription_mail_headers'
  * @uses get_userdata() To get the user data
  * @uses wp_mail() To send the mail
- * @uses do_action() Calls 'bbp_post_notify_subscribers' with the reply id
- *                    and topic id
+ * @uses do_action() Calls 'bbp_post_notify_subscribers' with the reply id,
+ *                    topic id and user id
  * @return bool True on success, false on failure
  */
@@ -1037 +1041 @@
     /** User ******************************************************************/
 
-    // Get subscribers and bail if empty
+    // Get topic subscribers and bail if empty
     $user_ids = bbp_get_topic_subscribers( $topic_id, true );
     if ( empty( $user_ids ) )
@@ -1105 +1109 @@
 
     do_action( 'bbp_post_notify_subscribers', $reply_id, $topic_id, $user_ids );
+
+    return true;
+}
+
+/**
+ * Sends notification emails for new topics to subscribed forums
+ *
+ * Gets new post's ID and check if there are subscribed users to that topic, and
+ * if there are, send notifications
+ *
+ * @since bbPress (rxxxx)
+ *
+ * @param int $topic_id ID of the newly made reply
+ * @uses bbp_is_subscriptions_active() To check if the subscriptions are active
+ * @uses bbp_get_topic_id() To validate the topic ID
+ * @uses bbp_get_forum_id() To validate the forum ID
+ * @uses bbp_is_topic_published() To make sure the topic is published
+ * @uses bbp_get_forum_subscribers() To get the forum subscribers
+ * @uses bbp_get_topic_author_display_name() To get the topic author's display name
+ * @uses do_action() Calls 'bbp_pre_notify_forum_subscribers' with the topic id,
+ *                    forum id and user id
+ * @uses apply_filters() Calls 'bbp_forum_subscription_mail_message' with the
+ *                    message, topic id, forum id and user id
+ * @uses apply_filters() Calls 'bbp_forum_subscription_mail_title' with the
+ *                    topic title, topic id, forum id and user id
+ * @uses apply_filters() Calls 'bbp_forum_subscription_mail_headers'
+ * @uses get_userdata() To get the user data
+ * @uses wp_mail() To send the mail
+ * @uses do_action() Calls 'bbp_post_notify_forum_subscribers' with the topic,
+ *                    id, forum id and user id
+ * @return bool True on success, false on failure
+ */
+function bbp_notify_forum_subscribers( $topic_id = 0, $forum_id = 0, $anonymous_data = false, $topic_author = 0 ) {
+
+    // Bail if subscriptions are turned off
+    if ( !bbp_is_subscriptions_active() )
+        return false;
+
+    /** Validation ************************************************************/
+
+    $topic_id = bbp_get_topic_id( $topic_id );
+    $forum_id = bbp_get_forum_id( $forum_id );
+
+    /** Topic *****************************************************************/
+
+    // Bail if topic is not published
+    if ( ! bbp_is_topic_published( $topic_id ) )
+        return false;
+
+    /** User ******************************************************************/
+
+    // Get forum subscribers and bail if empty
+    $user_ids = bbp_get_forum_subscribers( $forum_id, true );
+    if ( empty( $user_ids ) )
+        return false;
+
+    // Poster name
+    $topic_author_name = bbp_get_topic_author_display_name( $topic_id );
+
+    /** Mail ******************************************************************/
+
+    do_action( 'bbp_pre_notify_forum_subscribers', $topic_id, $forum_id, $user_ids );
+
+    // Remove filters from reply content and topic title to prevent content
+    // from being encoded with HTML entities, wrapped in paragraph tags, etc...
+    remove_all_filters( 'bbp_get_topic_content' );
+    remove_all_filters( 'bbp_get_topic_title'   );
+
+    // Strip tags from text
+    $topic_title   = strip_tags( bbp_get_topic_title( $topic_id ) );
+    $topic_content = strip_tags( bbp_get_topic_content( $topic_id ) );
+    $topic_url     = get_permalink( $topic_id );
+    $blog_name     = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
+
+    // Loop through users
+    foreach ( (array) $user_ids as $user_id ) {
+
+        // Don't send notifications to the person who made the post
+        if ( !empty( $topic_author ) && (int) $user_id === (int) $topic_author )
+            continue;
+
+        // For plugins to filter messages per reply/topic/user
+        $message = sprintf( __( '%1$s wrote:
+
+%2$s
+
+Topic Link: %3$s
+
+-----------
+
+You are receiving this email because you subscribed to a forum.
+
+Login and visit the topic to unsubscribe from these emails.', 'bbpress' ),
+
+            $topic_author_name,
+            $topic_content,
+            $topic_url
+        );
+        $message = apply_filters( 'bbp_forum_subscription_mail_message', $message, $topic_id, $forum_id, $user_id );
+        if ( empty( $message ) )
+            continue;
+
+        // For plugins to filter titles per reply/topic/user
+        $subject = apply_filters( 'bbp_forum_subscription_mail_title', '[' . $blog_name . '] ' . $topic_title, $topic_id, $forum_id, $user_id );
+        if ( empty( $subject ) )
+            continue;
+
+        // Custom headers
+        $headers = apply_filters( 'bbp_forum_subscription_mail_headers', array() );
+
+        // Get user data of this user
+        $user = get_userdata( $user_id );
+
+        // Send notification email
+        wp_mail( $user->user_email, $subject, $message, $headers );
+    }
+
+    do_action( 'bbp_post_notify_forum_subscribers', $topic_id, $forum_id, $user_ids );
 
     return true;