<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[36217] trunk: Rewrite: Add a `remove_rewrite_tag()` helper function.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/36217">36217</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/36217","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-01-07 09:38:06 +0000 (Thu, 07 Jan 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Rewrite: Add a `remove_rewrite_tag()` helper function.
It can be used to properly remove registered rewrite tags. Adds unit tests.
Fixes <a href="https://core.trac.wordpress.org/ticket/35236">#35236</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswprewritephp">trunk/src/wp-includes/class-wp-rewrite.php</a></li>
<li><a href="#trunksrcwpincludesrewritephp">trunk/src/wp-includes/rewrite.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsrewriterewriteTagsphp">trunk/tests/phpunit/tests/rewrite/rewriteTags.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswprewritephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-rewrite.php 2016-01-07 06:05:07 UTC (rev 36216)
+++ trunk/src/wp-includes/class-wp-rewrite.php 2016-01-07 09:38:06 UTC (rev 36217)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -841,7 +841,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Removes an existing rewrite tag.
+ *
+ * @since 4.5.0
+ * @access public
+ *
+ * @see WP_Rewrite::$rewritecode
+ * @see WP_Rewrite::$rewritereplace
+ * @see WP_Rewrite::$queryreplace
+ *
+ * @param string $tag Name of the rewrite tag to remove.
+ */
+ public function remove_rewrite_tag( $tag ) {
+ $position = array_search( $tag, $this->rewritecode );
+ if ( false !== $position && null !== $position ) {
+ unset( $this->rewritecode[ $position ] );
+ unset( $this->rewritereplace[ $position ] );
+ unset( $this->queryreplace[ $position ] );
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Generates rewrite rules from a permalink structure.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The main WP_Rewrite function for building the rewrite rule list. The
</span></span></pre></div>
<a id="trunksrcwpincludesrewritephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rewrite.php 2016-01-07 06:05:07 UTC (rev 36216)
+++ trunk/src/wp-includes/rewrite.php 2016-01-07 09:38:06 UTC (rev 36217)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -173,6 +173,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Removes an existing rewrite tag (like %postname%).
+ *
+ * @since 4.5.0
+ *
+ * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
+ *
+ * @param string $tag Name of the rewrite tag.
+ */
+function remove_rewrite_tag( $tag ) {
+ global $wp_rewrite;
+ $wp_rewrite->remove_rewrite_tag( $tag );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Add permalink structure.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span></span></pre></div>
<a id="trunktestsphpunittestsrewriterewriteTagsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/rewrite/rewriteTags.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rewrite/rewriteTags.php (rev 0)
+++ trunk/tests/phpunit/tests/rewrite/rewriteTags.php 2016-01-07 09:38:06 UTC (rev 36217)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,127 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group rewrite
+ */
+class Tests_Rewrite_Tags extends WP_UnitTestCase {
+ protected $rewritecode;
+ protected $rewritereplace;
+ protected $queryreplace;
+
+ public function setUp() {
+ global $wp_rewrite;
+ $this->rewritecode = $wp_rewrite->rewritecode;
+ $this->rewritereplace = $wp_rewrite->rewritereplace;
+ $this->queryreplace = $wp_rewrite->queryreplace;
+ }
+
+ public function tearDown() {
+ global $wp_rewrite;
+ $wp_rewrite->rewritecode = $this->rewritecode;
+ $wp_rewrite->rewritereplace = $this->rewritereplace;
+ $wp_rewrite->queryreplace = $this->queryreplace;
+ }
+
+ public function _invalid_rewrite_tags() {
+ return array(
+ array( 'foo', 'bar' ),
+ array( '%', 'bar' ),
+ array( '%a', 'bar' ),
+ array( 'a%', 'bar' ),
+ array( '%%', 'bar' ),
+ array( '', 'bar' ),
+ );
+ }
+
+ /**
+ * @dataProvider _invalid_rewrite_tags
+ *
+ * @param string $tag Rewrite tag.
+ * @param string $regex Regex.
+ */
+ public function test_add_rewrite_tag_invalid( $tag, $regex ) {
+ global $wp_rewrite;
+
+ add_rewrite_tag( $tag, $regex );
+ $this->assertNotContains( $tag, $wp_rewrite->rewritecode );
+ $this->assertNotContains( $regex, $wp_rewrite->rewritereplace );
+ $this->assertNotContains( $tag . '=', $wp_rewrite->queryreplace );
+ }
+
+ public function test_add_rewrite_tag_empty_query() {
+ global $wp_rewrite;
+
+ add_rewrite_tag( '%foo%', 'bar' );
+
+ $this->assertSame( array_merge( $this->rewritecode, array( '%foo%' ) ), $wp_rewrite->rewritecode );
+ $this->assertSame( array_merge( $this->rewritereplace, array( 'bar' ) ), $wp_rewrite->rewritereplace );
+ $this->assertSame( array_merge( $this->queryreplace, array( 'foo=' ) ), $wp_rewrite->queryreplace );
+ }
+
+ public function test_add_rewrite_tag_custom_query() {
+ global $wp_rewrite;
+
+ add_rewrite_tag( '%foo%', 'bar', 'baz=' );
+
+ $this->assertSame( array_merge( $this->rewritecode, array( '%foo%' ) ), $wp_rewrite->rewritecode );
+ $this->assertSame( array_merge( $this->rewritereplace, array( 'bar' ) ), $wp_rewrite->rewritereplace );
+ $this->assertSame( array_merge( $this->queryreplace, array( 'baz=' ) ), $wp_rewrite->queryreplace );
+ }
+
+ public function test_add_rewrite_tag_updates_existing() {
+ global $wp_rewrite;
+
+ add_rewrite_tag( '%pagename%', 'foo', 'bar=' );
+ $this->assertContains( '%pagename%', $wp_rewrite->rewritecode );
+ $this->assertContains( 'foo', $wp_rewrite->rewritereplace );
+ $this->assertNotContains( '([^/]+?)', $wp_rewrite->rewritereplace );
+ $this->assertContains( 'bar=', $wp_rewrite->queryreplace );
+ $this->assertNotContains( 'pagename=', $wp_rewrite->queryreplace );
+ }
+
+ public function test_remove_rewrite_tag() {
+ global $wp_rewrite;
+
+ add_rewrite_tag( '%foo%', 'bar', 'baz=' );
+ $this->assertSame( array_merge( $this->rewritecode, array( '%foo%' ) ), $wp_rewrite->rewritecode );
+ $this->assertSame( array_merge( $this->rewritereplace, array( 'bar' ) ), $wp_rewrite->rewritereplace );
+ $this->assertSame( array_merge( $this->queryreplace, array( 'baz=' ) ), $wp_rewrite->queryreplace );
+
+ remove_rewrite_tag( '%foo%' );
+ $this->assertSame( $this->rewritecode, $wp_rewrite->rewritecode );
+ $this->assertSame( $this->rewritereplace, $wp_rewrite->rewritereplace );
+ $this->assertSame( $this->queryreplace, $wp_rewrite->queryreplace );
+ }
+
+ public function test_remove_rewrite_tag_internal_tag() {
+ global $wp_rewrite;
+
+ $this->assertContains( '%post_id%', $wp_rewrite->rewritecode );
+ $this->assertContains( '([0-9]+)', $wp_rewrite->rewritereplace );
+ $this->assertContains( 'p=', $wp_rewrite->queryreplace );
+
+ remove_rewrite_tag( '%post_id%' );
+
+ $this->assertNotContains( '%post_id%', $wp_rewrite->rewritecode );
+ $this->assertNotContains( '([0-9]+)', $wp_rewrite->rewritereplace );
+ $this->assertNotContains( 'p=', $wp_rewrite->queryreplace );
+ }
+
+ public function test_remove_rewrite_tag_only_removes_one_array_value() {
+ global $wp_rewrite;
+
+ add_rewrite_tag( '%foo%', '([0-9]{1,2})', 'post_type=foo&name=' );
+ $this->assertSame( array_merge( $this->rewritecode, array( '%foo%' ) ), $wp_rewrite->rewritecode );
+ $this->assertSame( array_merge( $this->rewritereplace, array( '([0-9]{1,2})' ) ), $wp_rewrite->rewritereplace );
+ $this->assertSame( array_merge( $this->queryreplace, array( 'post_type=foo&name=' ) ), $wp_rewrite->queryreplace );
+
+ remove_rewrite_tag( '%foo%' );
+ $this->assertSame( $this->rewritecode, $wp_rewrite->rewritecode );
+ $this->assertSame( $this->rewritereplace, $wp_rewrite->rewritereplace );
+ $this->assertSame( $this->queryreplace, $wp_rewrite->queryreplace );
+
+ $this->assertNotContains( '%foo%', $wp_rewrite->rewritecode );
+ $this->assertContains( '([0-9]{1,2})', $wp_rewrite->rewritereplace );
+ $this->assertNotContains( 'post_type=foo&name=', $wp_rewrite->queryreplace );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/rewrite/rewriteTags.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>