Changeset 5156 for trunk/includes/topics/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/topics/template.php (modified) (1 diff)

trunk/includes/topics/template.php

@@ -1808 +1808 @@
     }
 
+/** Topic Subscriptions *******************************************************/
+
+/**
+ * Output the topic subscription link
+ *
+ * @since bbPress (rxxxx)
+ *
+ * @uses bbp_get_topic_subscription_link()
+ */
+function bbp_topic_subscription_link( $args = array() ) {
+    echo bbp_get_topic_subscription_link( $args );
+}
+
+    /**
+     * Get the forum subscription link
+     *
+     * A custom wrapper for bbp_get_user_subscribe_link()
+     *
+     * @since bbPress (rxxxx)
+     *
+     * @uses bbp_parse_args()
+     * @uses bbp_get_user_subscribe_link()
+     * @uses apply_filters() Calls 'bbp_get_topic_subscribe_link'
+     */
+    function bbp_get_topic_subscription_link( $args = array() ) {
+
+        // No link
+        $retval = false;
+
+        // Parse the arguments
+        $r = bbp_parse_args( $args, array(
+            'user_id'     => 0,
+            'topic_id'    => 0,
+            'before'      => ' | ',
+            'after'       => '',
+            'subscribe'   => __( 'Subscribe',   'bbpress' ),
+            'unsubscribe' => __( 'Unsubscribe', 'bbpress' )
+        ), 'get_forum_subscribe_link' );
+
+        // Get the link
+        $retval = bbp_get_user_subscribe_link( $r );
+
+        return apply_filters( 'bbp_get_topic_subscribe_link', $retval, $r );
+    }
+
+/** Topic Favorites ***********************************************************/
+
+/**
+ * Output the topic favorite link
+ *
+ * @since bbPress (rxxxx)
+ *
+ * @uses bbp_get_topic_favorite_link()
+ */
+function bbp_topic_favorite_link( $args = array() ) {
+    echo bbp_get_topic_favorite_link( $args );
+}
+
+    /**
+     * Get the forum favorite link
+     *
+     * A custom wrapper for bbp_get_user_favorite_link()
+     *
+     * @since bbPress (rxxxx)
+     *
+     * @uses bbp_parse_args()
+     * @uses bbp_get_user_favorites_link()
+     * @uses apply_filters() Calls 'bbp_get_topic_favorite_link'
+     */
+    function bbp_get_topic_favorite_link( $args = array() ) {
+
+        // No link
+        $retval = false;
+
+        // Parse the arguments
+        $r = bbp_parse_args( $args, array(
+            'user_id'   => 0,
+            'topic_id'  => 0,
+            'before'    => '',
+            'after'     => '',
+            'favorite'  => __( 'Favorite',   'bbpress' ),
+            'favorited' => __( 'Unfavorite', 'bbpress' )
+        ), 'get_forum_favorite_link' );
+
+        // Get the link
+        $retval = bbp_get_user_favorites_link( $r );
+
+        return apply_filters( 'bbp_get_topic_favorite_link', $retval, $r );
+    }
+
 /** Topic Last Reply **********************************************************/