Ticket #35235: 35235.2.diff

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

@@ -1745 +1745 @@
         }
 
         /**
+         * Removes a permalink structure.
+         *
+         * @since 4.5.0
+         * @access public
+         *
+         * @param string $name Name for permalink structure.
+         */
+        public function remove_permastruct( $name ) {
+                unset( $this->extra_permastructs[ $name ] );
+        }
+
+        /**
          * Removes rewrite rules and then recreate rewrite rules.
          *
          * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option.

src/wp-includes/rewrite.php

@@ -178 +178 @@
  * @since 3.0.0
  *
  * @see WP_Rewrite::add_permastruct()
- * @global WP_Rewrite $wp_rewrite
+ * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
  *
  * @param string $name   Name for permalink structure.
  * @param string $struct Permalink structure.
@@ -198 +198 @@
 }
 
 /**
+ * Remove permalink structure.
+ *
+ * Can only be used to remove permastructs that were added using add_permastruct().
+ * Built-in permastructs cannot be removed.
+ *
+ * @since 4.5.0
+ *
+ * @see WP_Rewrite::remove_permastruct()
+ * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
+ *
+ * @param string $name Name for permalink structure.
+ */
+function remove_permastruct( $name ) {
+        global $wp_rewrite;
+
+        $wp_rewrite->remove_permastruct( $name );
+}
+
+/**
  * Add a new feed type like /atom1/.
  *
  * @since 2.1.0

new file tests/phpunit/tests/rewrite/permastructs.php

@@ +1 @@
+<?php
+
+/**
+ * @group rewrite
+ */
+class Tests_Rewrite_Permastructs extends WP_UnitTestCase {
+
+        public function setUp() {
+                parent::setUp();
+
+                $this->set_permalink_structure( '/%postname%/' );
+        }
+
+        public function test_add_permastruct(  ) {
+                global $wp_rewrite;
+
+                add_permastruct( 'foo', 'bar/%foo%' );
+                $this->assertEqualSets( array(
+                        'with_front'  => true,
+                        'ep_mask'     => EP_NONE,
+                        'paged'       => true,
+                        'feed'        => true,
+                        'walk_dirs'   => true,
+                        'endpoints'   => true,
+                        'forcomments' => false,
+                        'struct'      => '/bar/%foo%',
+                ), $wp_rewrite->extra_permastructs['foo'] );
+        }
+
+        public function test_remove_permastruct(  ) {
+                global $wp_rewrite;
+
+                add_permastruct( 'foo', 'bar/%foo%' );
+                $this->assertInternalType( 'array', $wp_rewrite->extra_permastructs['foo'] );
+                $this->assertSame( '/bar/%foo%', $wp_rewrite->extra_permastructs['foo']['struct'] );
+
+                remove_permastruct( 'foo' );
+                $this->assertFalse( isset( $wp_rewrite->extra_permastructs['foo'] ) );
+        }
+}