Changeset 6918

Timestamp:

11/05/2019 08:28:43 PM (4 years ago)

Author:

johnjamesjacoby

Message:

Subscriptions: clean up code comparisons and documentation.

This commit adds some inline documentation to provide a bit more clarity around what subnscriptions checks and actions are being taken, and adds parenthesis to nested comparisons to improve code readability.

See #3235.

Location:

trunk/src/includes

Files:

• admin/metaboxes.php (modified) (2 diffs)
• replies/functions.php (modified) (1 diff)
• topics/functions.php (modified) (2 diffs)

trunk/src/includes/admin/metaboxes.php

@@ -732 +732 @@
 
 /**
- * See who subscribed to a topic
+ * See who is subscribed to a topic
  *
  * @since 2.6.0 bbPress (r6197)
@@ -772 +772 @@
 
 /**
- * See who subscribed to a forum
+ * See who is subscribed to a forum
  *
  * @since 2.6.0 bbPress (r6197)

trunk/src/includes/replies/functions.php

@@ -826 +826 @@
     // Handle Subscription Checkbox
     if ( bbp_is_subscriptions_active() && ! empty( $author_id ) && ! empty( $topic_id ) ) {
+
+        // Check if subscribed
         $subscribed = bbp_is_user_subscribed( $author_id, $topic_id );
-        $subscheck  = ( ! empty( $_POST['bbp_topic_subscription'] ) && ( 'bbp_subscribe' === $_POST['bbp_topic_subscription'] ) ) ? true : false;
+
+        // Check for action
+        $subscheck  = ( ! empty( $_POST['bbp_topic_subscription'] ) && ( 'bbp_subscribe' === $_POST['bbp_topic_subscription'] ) )
+            ? true
+            : false;
 
         // Subscribed and unsubscribing
-        if ( true === $subscribed && false === $subscheck ) {
+        if ( ( true === $subscribed ) && ( false === $subscheck ) ) {
             bbp_remove_user_subscription( $author_id, $topic_id );
 
-        // Subscribing
-        } elseif ( false === $subscribed && true === $subscheck ) {
+        // Not subscribed and subscribing
+        } elseif ( ( false === $subscribed ) && ( true === $subscheck ) ) {
             bbp_add_user_subscription( $author_id, $topic_id );
         }

trunk/src/includes/topics/functions.php

@@ -798 +798 @@
     // Handle Subscription Checkbox
     if ( bbp_is_subscriptions_active() && ! empty( $author_id ) ) {
+
+        // Check if subscribed
         $subscribed = bbp_is_user_subscribed( $author_id, $topic_id );
+
+        // Check for action
         $subscheck  = ( ! empty( $_POST['bbp_topic_subscription'] ) && ( 'bbp_subscribe' === $_POST['bbp_topic_subscription'] ) )
             ? true
@@ -804 +808 @@
 
         // Subscribed and unsubscribing
-        if ( true === $subscribed && false === $subscheck ) {
+        if ( ( true === $subscribed ) && ( false === $subscheck ) ) {
             bbp_remove_user_subscription( $author_id, $topic_id );
 
-        // Subscribing
-        } elseif ( false === $subscribed && true === $subscheck ) {
+        // Not subscribed and subscribing
+        } elseif ( ( false === $subscribed ) && ( true === $subscheck ) ) {
             bbp_add_user_subscription( $author_id, $topic_id );
         }