Changeset 4543 for trunk/includes/users/template-tags.php

Timestamp:

12/05/2012 09:02:01 PM (14 years ago)

Author:

johnjamesjacoby

Message:

Subscriptions/Favorites:

• Improvements to AJAX handling.
• Introduces bbp_ajax_response() function in common/functions.php, to handle JSON output.
• Adds AJAX failure responses.
• Props MZAWeb.
• Fixes #1905.

File:

• trunk/includes/users/template-tags.php (modified) (6 diffs)

trunk/includes/users/template-tags.php

@@ -640 +640 @@
          * @param int $user_id Optional. User id
          * @param int $topic_id Optional. Topic id
+         * @param bool $wrap Optional. If you want to wrap the link in <span id="favorite-toggle">. See ajax_favorite()
          * @uses bbp_get_user_id() To get the user id
          * @uses current_user_can() If the current user can edit the user
@@ -651 +652 @@
          * @return string User favorites link
          */
-        function bbp_get_user_favorites_link( $add = array(), $rem = array(), $user_id = 0, $topic_id = 0 ) {
+        function bbp_get_user_favorites_link( $add = array(), $rem = array(), $user_id = 0, $topic_id = 0, $wrap = true ) {
                 if ( !bbp_is_favorites_active() )
                         return false;
@@ -704 +705 @@
                 } elseif ( is_singular( bbp_get_reply_post_type() ) ) {
                         $permalink = bbp_get_topic_permalink( $topic_id );
-                } elseif ( bbp_is_query_name( 'bbp_single_topic' ) ) {
+                } else {
                         $permalink = get_permalink();
                 }
 
-                $url    = esc_url( wp_nonce_url( add_query_arg( $favs, $permalink ), 'toggle-favorite_' . $topic_id ) );
-                $is_fav = $is_fav ? 'is-favorite' : '';
-                $html   = '<span id="favorite-toggle"><span id="favorite-' . $topic_id . '" class="' . $is_fav . '">' . $pre . '<a href="' . $url . '" class="dim:favorite-toggle:favorite-' . $topic_id . ':is-favorite">' . $mid . '</a>' . $_post . '</span></span>';
+                $url  = esc_url( wp_nonce_url( add_query_arg( $favs, $permalink ), 'toggle-favorite_' . $topic_id ) );
+                $fav  = $is_fav ? 'is-favorite' : '';
+                $html = sprintf( '<span id="favorite-%d" class="%s">%s<a href="%s" class="favorite-toggle" data-topic="%d" >%s</a>%s</span>', $topic_id, $fav, $pre, $url, $topic_id, $mid, $_post );
+
+                // Initial output is wrapped in a span, ajax output is hooked to this
+                if ( !empty( $wrap ) ) {
+                        $html = '<span id="favorite-toggle">' . $html . '</span>';
+                }
 
                 // Return the link
@@ -801 +807 @@
          *  - 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="favorite-toggle">.
          * @uses bbp_get_user_id() To get the user id
          * @uses current_user_can() To check if the current user can edit user
@@ -812 +819 @@
          * @return string Permanent link to topic
          */
-        function bbp_get_user_subscribe_link( $args = '', $user_id = 0 ) {
+        function bbp_get_user_subscribe_link( $args = '', $user_id = 0, $wrap = true ) {
                 if ( !bbp_is_subscriptions_active() )
                         return;
@@ -856 +863 @@
                 } elseif ( is_singular( bbp_get_reply_post_type() ) ) {
                         $permalink = bbp_get_topic_permalink( $topic_id );
-                } elseif ( bbp_is_query_name( 'bbp_single_topic' ) ) {
+                } else {
                         $permalink = get_permalink();
                 }
 
-                $url        = esc_url( wp_nonce_url( add_query_arg( $query_args, $permalink ), 'toggle-subscription_' . $topic_id ) );
-                $subscribed = $is_subscribed ? ' class="is_subscribed"' : '';
-                $html       = '<span id="subscription-toggle">' . $r['before'] . '<span id="subscribe-' . $topic_id . '"' . $subscribed . '><a href="' . $url . '" class="dim:subscription-toggle:subscribe-' . $topic_id . ':is-subscribed">' . $text . '</a></span>' . $r['after'] . '</span>';
+                $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>' . $r['after'] . '</span>', $r['before'], $topic_id, $sub, $url, $topic_id, $text );
+
+                // Initial output is wrapped in a span, ajax output is hooked to this
+                if ( !empty( $wrap ) ) {
+                        $html = '<span id="subscription-toggle">' . $html . '</span>';
+                }
 
                 // Return the link