Changeset 6915

Timestamp:

11/03/2019 03:27:08 AM (6 years ago)

Author:

johnjamesjacoby

Message:

Stickies: make sure unapproved topics are unstuck also.

This commit removes a hard coded call to bbp_unstick_topic() and hooks into the neighboring bbp_stick_topic action, while also hooking into the bbp_unapprove_topic action.

A small bit of code clean-up and inline documentation additions accompany this commit, to improve a bit of the surrounding relevant code.

Fixes #3246.

Location:

trunk/src/includes

Files:

• core/actions.php (modified) (1 diff)
• topics/functions.php (modified) (4 diffs)

trunk/src/includes/core/actions.php

@@ -240 +240 @@
 
 // Sticky
-add_action( 'bbp_spam_topic',   'bbp_unstick_topic' );
-add_action( 'bbp_trash_topic',  'bbp_unstick_topic' );
-add_action( 'bbp_delete_topic', 'bbp_unstick_topic' );
+add_action( 'bbp_stick_topic',     'bbp_unstick_topic' );
+add_action( 'bbp_unapprove_topic', 'bbp_unstick_topic' );
+add_action( 'bbp_spam_topic',      'bbp_unstick_topic' );
+add_action( 'bbp_trash_topic',     'bbp_unstick_topic' );
+add_action( 'bbp_delete_topic',    'bbp_unstick_topic' );
 
 // Update topic branch

trunk/src/includes/topics/functions.php

@@ -3109 +3109 @@
     }
 
-    // We may have a super sticky to which we want to convert into a normal
-    // sticky and vice versa; unstick the topic first to avoid any possible error.
-    bbp_unstick_topic( $topic_id );
-
-    $forum_id = empty( $super ) ? bbp_get_topic_forum_id( $topic_id ) : 0;
+    do_action( 'bbp_stick_topic', $topic_id, $super );
+
+    // Maybe get the forum ID if not getting supers
+    $forum_id = empty( $super )
+        ? bbp_get_topic_forum_id( $topic_id )
+        : 0;
+
+    // Get the stickies, maybe from the forum ID
     $stickies = bbp_get_stickies( $forum_id );
 
-    do_action( 'bbp_stick_topic', $topic_id, $super );
-
-    if ( ! is_array( $stickies ) ) {
-        $stickies   = array( $topic_id );
-    } else {
-        $stickies[] = $topic_id;
-    }
+    // Add the topic to the stickies
+    $stickies[] = $topic_id;
 
     // Pull out duplicates and empties
@@ -3136 +3134 @@
     // Reset keys
     $stickies = array_values( $stickies );
-    $success  = ! empty( $super ) ? update_option( '_bbp_super_sticky_topics', $stickies ) : update_post_meta( $forum_id, '_bbp_sticky_topics', $stickies );
+
+    // Update
+    $success  = ! empty( $super )
+        ? update_option( '_bbp_super_sticky_topics', $stickies )
+        : update_post_meta( $forum_id, '_bbp_sticky_topics', $stickies );
 
     do_action( 'bbp_stuck_topic', $topic_id, $super, $success );
@@ -3238 +3240 @@
  */
 function bbp_unstick_topic( $topic_id = 0 ) {
+
+    // Get topic sticky status
     $topic_id = bbp_get_topic_id( $topic_id );
     $super    = bbp_is_topic_super_sticky( $topic_id );
@@ -3246 +3250 @@
     do_action( 'bbp_unstick_topic', $topic_id );
 
+    // Nothing to unstick
     if ( empty( $stickies ) ) {
         $success = true;
+
+    // Topic not in stickies
     } elseif ( ! in_array( $topic_id, $stickies, true ) ) {
         $success = true;
+
+    // Topic not in stickies
     } elseif ( false === $offset ) {
         $success = true;
+
+    // Splice out the offset
     } else {
         array_splice( $stickies, $offset, 1 );
+
         if ( empty( $stickies ) ) {
-            $success = ! empty( $super ) ? delete_option( '_bbp_super_sticky_topics'            ) : delete_post_meta( $forum_id, '_bbp_sticky_topics'            );
+            $success = ! empty( $super )
+                ? delete_option( '_bbp_super_sticky_topics' )
+                : delete_post_meta( $forum_id, '_bbp_sticky_topics' );
         } else {
-            $success = ! empty( $super ) ? update_option( '_bbp_super_sticky_topics', $stickies ) : update_post_meta( $forum_id, '_bbp_sticky_topics', $stickies );
+            $success = ! empty( $super )
+                ? update_option( '_bbp_super_sticky_topics', $stickies )
+                : update_post_meta( $forum_id, '_bbp_sticky_topics', $stickies );
         }
     }