Ticket #35600: 35600-3.diff

src/wp-includes/post.php

@@ -2169 +2169 @@
         if ( ! in_array($post_id, $stickies) )
                 $stickies[] = $post_id;
 
-        update_option('sticky_posts', $stickies);
+        $updated = update_option('sticky_posts', $stickies);
+
+        if ( $updated ) {
+                /**
+                 * Fires after a post is successfully stuck.
+                 *
+                 * @since 4.6.0
+                 *
+                 * @param int $post_id The ID of the post that was stuck.
+                 */
+                do_action( 'post_stuck', $post_id );
+        }
 }
 
 /**
@@ -2196 +2207 @@
 
         array_splice($stickies, $offset, 1);
 
-        update_option('sticky_posts', $stickies);
+        $updated = update_option('sticky_posts', $stickies);
+
+        if ( $updated ) {
+                /**
+                 * Fires after a post is successfully unstuck.
+                 *
+                 * @since 4.6.0
+                 *
+                 * @param int $post_id The ID of the post that was unstuck.
+                 */
+                do_action( 'post_unstuck', $post_id );
+        }
 }
 
 /**

tests/phpunit/tests/post.php

@@ -1182 +1182 @@
         }
 
         /**
+         * Test that hooks are fired when post is stuck and unstuck.
+         *
+         * @ticket 35600
+         */
+        function test_hooks_fire_when_post_is_stuck_and_unstuck() {
+                // Create a dummy post.
+                $test_post = self::factory()->post->create_and_get( array(
+                        'post_title' => 'Dummy post title',
+                        'post_content' => 'Dummy post content',
+                ) );
+
+                $this->assertFalse( is_sticky( $test_post->ID ) );
+
+                // Hook callbacks.
+                add_action( 'post_stuck', array( $this, 'stuck_callback' ) );
+                add_action( 'post_unstuck', array( $this, 'unstuck_callback' ) );
+
+                stick_post( $test_post->ID );
+
+                $this->assertTrue( is_sticky( $test_post->ID ) );
+
+                unstick_post( $test_post->ID );
+
+                $this->assertFalse( is_sticky( $test_post->ID ) );
+
+                // Verify the hooks ran when post was stuck and unstuck.
+                $this->assertEquals( 'yes', get_option( '_test_stuck_post_' . $test_post->ID, false ) );
+                $this->assertEquals( 'yes', get_option( '_test_unstuck_post_' . $test_post->ID, false ) );
+        }
+
+        /**
+         * Helper for `test_hooks_fire_when_post_is_stuck_and_unstuck`.
+         */
+        function stuck_callback( $post_id ) {
+                update_option( '_test_stuck_post_' . $post_id, 'yes' );
+        }
+
+        /**
+         * Helper for `test_hooks_fire_when_post_is_stuck_and_unstuck`.
+         */
+        function unstuck_callback( $post_id ) {
+                update_option( '_test_unstuck_post_' . $post_id, 'yes' );
+        }
+
+        /**
          * If a post is updated without providing a post_name param,
          * a new slug should not be generated.
          *