Changeset 5156 for trunk/includes/users/template.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/users/template.php (modified) (9 diffs)

trunk/includes/users/template.php

@@ -613 +613 @@
 
 /** Anonymous Fields **********************************************************/
-    
+
 /**
  * Output the author disylay-name of a topic or reply.
@@ -886 +886 @@
      */
     function bbp_get_user_favorites_link( $args = '', $user_id = 0, $wrap = true ) {
-        if ( !bbp_is_favorites_active() )
+        if ( ! bbp_is_favorites_active() ) {
             return false;
+        }
 
         // Parse arguments against default values
@@ -907 +908 @@
 
         // No link if you can't edit yourself
-        if ( !current_user_can( 'edit_user', (int) $user_id ) ) {
+        if ( ! current_user_can( 'edit_user', (int) $user_id ) ) {
             return false;
         }
@@ -913 +914 @@
         // Decide which link to show
         $is_fav = bbp_is_user_favorite( $user_id, $topic_id );
-        if ( !empty( $is_fav ) ) {
+        if ( ! empty( $is_fav ) ) {
             $text       = $r['favorited'];
             $query_args = array( 'action' => 'bbp_favorite_remove', 'topic_id' => $topic_id );
@@ -936 +937 @@
 
         // Initial output is wrapped in a span, ajax output is hooked to this
-        if ( !empty( $wrap ) ) {
+        if ( ! empty( $wrap ) ) {
             $html = '<span id="favorite-toggle">' . $html . '</span>';
         }
@@ -1019 +1020 @@
 }
     /**
-     * Return the link to subscribe/unsubscribe from a topic
+     * Return the link to subscribe/unsubscribe from a forum or topic
      *
      * @since bbPress (r2668)
@@ -1028 +1029 @@
      *  - user_id: User id
      *  - topic_id: Topic id
+     *  - forum_id: Forum id
      *  - before: Before the link
      *  - after: After the link
      * @param int $user_id Optional. User id
      * @param bool $wrap Optional. If you want to wrap the link in <span id="subscription-toggle">.
+     * @uses bbp_is_subscriptions_active() to check if subscriptions are active
      * @uses bbp_get_user_id() To get the user id
+     * @uses bbp_get_user_id() To get the user id
+     * @uses bbp_get_topic_id() To get the topic id
+     * @uses bbp_get_forum_id() To get the forum id
      * @uses current_user_can() To check if the current user can edit user
-     * @uses bbp_get_topic_id() To get the topic id
-     * @uses bbp_is_user_subscribed() To check if the user is subscribed
+     * @uses bbp_is_user_subscribed_to_forum() To check if the user is subscribed to the forum
+     * @uses bbp_is_user_subscribed_to_topic() To check if the user is subscribed to the topic
      * @uses bbp_is_subscriptions() To check if it's the subscriptions page
      * @uses bbp_get_subscriptions_permalink() To get subscriptions link
@@ -1044 +1050 @@
      */
     function bbp_get_user_subscribe_link( $args = '', $user_id = 0, $wrap = true ) {
-        if ( !bbp_is_subscriptions_active() )
+        if ( ! bbp_is_subscriptions_active() ) {
             return;
+        }
 
         // Parse arguments against default values
@@ -1053 +1060 @@
             'user_id'     => 0,
             'topic_id'    => 0,
+            'forum_id'    => 0,
             'before'      => '&nbsp;|&nbsp;',
             'after'       => ''
         ), 'get_user_subscribe_link' );
 
-        // Validate user and topic ID's
+        // Validate user and object ID's
         $user_id  = bbp_get_user_id( $r['user_id'], true, true );
         $topic_id = bbp_get_topic_id( $r['topic_id'] );
-        if ( empty( $user_id ) || empty( $topic_id ) ) {
+        $forum_id = bbp_get_forum_id( $r['forum_id'] );
+        if ( empty( $user_id ) || ( empty( $topic_id ) && empty( $forum_id ) ) ) {
             return false;
         }
 
         // No link if you can't edit yourself
-        if ( !current_user_can( 'edit_user', (int) $user_id ) ) {
+        if ( ! current_user_can( 'edit_user', (int) $user_id ) ) {
             return false;
         }
 
-        // Decide which link to show
-        $is_subscribed = bbp_is_user_subscribed( $user_id, $topic_id );
-        if ( !empty( $is_subscribed ) ) {
-            $text       = $r['unsubscribe'];
-            $query_args = array( 'action' => 'bbp_unsubscribe', 'topic_id' => $topic_id );
+        // Check if viewing a single forum
+        if ( empty( $topic_id ) && ! empty( $forum_id ) ) {
+
+            // Decide which link to show
+            $is_subscribed = bbp_is_user_subscribed_to_forum( $user_id, $forum_id );
+            if ( ! empty( $is_subscribed ) ) {
+                $text       = $r['unsubscribe'];
+                $query_args = array( 'action' => 'bbp_unsubscribe', 'forum_id' => $forum_id );
+            } else {
+                $text       = $r['subscribe'];
+                $query_args = array( 'action' => 'bbp_subscribe',   'forum_id' => $forum_id );
+            }
+
+            // Create the link based where the user is and if the user is
+            // subscribed already
+            if ( bbp_is_subscriptions() ) {
+                $permalink = bbp_get_subscriptions_permalink( $user_id );
+            } elseif ( bbp_is_single_forum() || bbp_is_single_reply() ) {
+                $permalink = bbp_get_forum_permalink( $forum_id );
+            } else {
+                $permalink = get_permalink();
+            }
+
+            $url  = esc_url( wp_nonce_url( add_query_arg( $query_args, $permalink ), 'toggle-subscription_' . $forum_id ) );
+            $sub  = $is_subscribed ? ' class="is-subscribed"' : '';
+            $html = sprintf( '%s<span id="subscribe-%d"  %s><a href="%s" class="subscription-toggle" data-forum="%d">%s</a></span>%s', $r['before'], $forum_id, $sub, $url, $forum_id, $text, $r['after'] );
+
+            // Initial output is wrapped in a span, ajax output is hooked to this
+            if ( !empty( $wrap ) ) {
+                $html = '<span id="subscription-toggle">' . $html . '</span>';
+            }
+
         } else {
-            $text       = $r['subscribe'];
-            $query_args = array( 'action' => 'bbp_subscribe', 'topic_id' => $topic_id );
-        }
-
-        // Create the link based where the user is and if the user is
-        // subscribed already
-        if ( bbp_is_subscriptions() ) {
-            $permalink = bbp_get_subscriptions_permalink( $user_id );
-        } elseif ( bbp_is_single_topic() || bbp_is_single_reply() ) {
-            $permalink = bbp_get_topic_permalink( $topic_id );
-        } else {
-            $permalink = get_permalink();
-        }
-
-        $url  = esc_url( wp_nonce_url( add_query_arg( $query_args, $permalink ), 'toggle-subscription_' . $topic_id ) );
-        $sub  = $is_subscribed ? ' class="is-subscribed"' : '';
-        $html = sprintf( '%s<span id="subscribe-%d"  %s><a href="%s" class="subscription-toggle" data-topic="%d">%s</a></span>%s', $r['before'], $topic_id, $sub, $url, $topic_id, $text, $r['after'] );
-
-        // Initial output is wrapped in a span, ajax output is hooked to this
-        if ( !empty( $wrap ) ) {
-            $html = '<span id="subscription-toggle">' . $html . '</span>';
+
+            // Decide which link to show
+            $is_subscribed = bbp_is_user_subscribed_to_topic( $user_id, $topic_id );
+            if ( ! empty( $is_subscribed ) ) {
+                $text       = $r['unsubscribe'];
+                $query_args = array( 'action' => 'bbp_unsubscribe', 'topic_id' => $topic_id );
+            } else {
+                $text       = $r['subscribe'];
+                $query_args = array( 'action' => 'bbp_subscribe',   'topic_id' => $topic_id );
+            }
+
+            // Create the link based where the user is and if the user is
+            // subscribed already
+            if ( bbp_is_subscriptions() ) {
+                $permalink = bbp_get_subscriptions_permalink( $user_id );
+            } elseif ( bbp_is_single_topic() || bbp_is_single_reply() ) {
+                $permalink = bbp_get_topic_permalink( $topic_id );
+            } else {
+                $permalink = get_permalink();
+            }
+
+            $url  = esc_url( wp_nonce_url( add_query_arg( $query_args, $permalink ), 'toggle-subscription_' . $topic_id ) );
+            $sub  = $is_subscribed ? ' class="is-subscribed"' : '';
+            $html = sprintf( '%s<span id="subscribe-%d"  %s><a href="%s" class="subscription-toggle" data-topic="%d">%s</a></span>%s', $r['before'], $topic_id, $sub, $url, $topic_id, $text, $r['after'] );
+
+            // Initial output is wrapped in a span, ajax output is hooked to this
+            if ( !empty( $wrap ) ) {
+                $html = '<span id="subscription-toggle">' . $html . '</span>';
+            }
         }