Ticket #28517: 28517.diff

src/wp-includes/class-wp-rewrite.php

@@ -1798 +1798 @@
          * @staticvar bool $do_hard_later
          *
          * @param bool $hard Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush). Default is true (hard).
+         * @return bool True on a hard flush attempt, false on a soft flush attempt.
          */
         public function flush_rules( $hard = true ) {
                 static $do_hard_later = null;
@@ -1822 +1823 @@
                  *
                  * A "hard" flush updates .htaccess (Apache) or web.config (IIS).
                  *
-                 * @since 3.7.0
+                 * @since 4.8.0
                  *
-                 * @param bool $hard Whether to flush rewrite rules "hard". Default true.
+                 * @param bool $hard Whether to flush rewrite rules "hard".
                  */
-                if ( ! $hard || ! apply_filters( 'flush_rewrite_rules_hard', true ) ) {
-                        return;
+                $hard = apply_filters( 'flush_rewrite_rules_hard', $hard );
+
+                if ( ! $hard ) {
+                        return false;
                 }
-                if ( function_exists( 'save_mod_rewrite_rules' ) )
+
+                if ( function_exists( 'save_mod_rewrite_rules' ) ) {
                         save_mod_rewrite_rules();
-                if ( function_exists( 'iis7_save_url_rewrite_rules' ) )
+                }
+
+                if ( function_exists( 'iis7_save_url_rewrite_rules' ) ) {
                         iis7_save_url_rewrite_rules();
+                }
+
+                return true;
         }
 
         /**

src/wp-includes/rewrite.php

@@ -267 +267 @@
  *
  * @param bool $hard Whether to update .htaccess (hard flush) or just update
  *                       rewrite_rules transient (soft flush). Default is true (hard).
+ * @return bool True on a hard flush attempt, false on a soft flush attempt.
  */
 function flush_rewrite_rules( $hard = true ) {
         global $wp_rewrite;
-        $wp_rewrite->flush_rules( $hard );
+        return $wp_rewrite->flush_rules( $hard );
 }
 
 /**

tests/phpunit/tests/rewrite.php

@@ -399 +399 @@
                 $this->assertInternalType( 'array', $rewrite_rules );
                 $this->assertNotEmpty( $rewrite_rules );
         }
+
+        /**
+         * @ticket 28517
+         */
+        function test_flush_rules_hard_true_no_filters() {
+                $this->assertTrue( flush_rewrite_rules( true ) );
+        }
+
+        /**
+         * @ticket 28517
+         */
+        function test_flush_rules_hard_false_no_filters() {
+                $this->assertFalse( flush_rewrite_rules( false ) );
+        }
+
+        /**
+         * @ticket 28517
+         */
+        function test_flush_rules_hard_true_with_filters_true() {
+                add_filter( 'flush_rewrite_rules_hard', '__return_true' );
+                $this->assertTrue( flush_rewrite_rules( true ) );
+        }
+
+        /**
+         * @ticket 28517
+         */
+        function test_flush_rules_hard_true_with_filters_false() {
+                add_filter( 'flush_rewrite_rules_hard', '__return_false' );
+                $this->assertFalse( flush_rewrite_rules( true ) );
+        }
+
+        /**
+         * @ticket 28517
+         */
+        function test_flush_rules_hard_false_with_filters_true() {
+                add_filter( 'flush_rewrite_rules_hard', '__return_true' );
+                $this->assertTrue( flush_rewrite_rules( false ) );
+        }
+
+        /**
+         * @ticket 28517
+         */
+        function test_flush_rules_hard_false_with_filters_false() {
+                add_filter( 'flush_rewrite_rules_hard', '__return_false' );
+                $this->assertFalse( flush_rewrite_rules( false ) );
+        }
 }