<!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>[34708] trunk: Rewrite: allow `add_rewrite_rule|WP_Rewrite::add_rule()` to accept an associative array for the value of `$redirect` instead of requiring a query string.</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/34708">34708</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/34708","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-30 01:10:03 +0000 (Wed, 30 Sep 2015)</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: allow `add_rewrite_rule|WP_Rewrite::add_rule()` to accept an associative array for the value of `$redirect` instead of requiring a query string.
Adds unit tests.
Props scribu, DrewAPicture.
Fixes <a href="https://core.trac.wordpress.org/ticket/16840">#16840</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswprewritephp">trunk/src/wp-includes/class-wp-rewrite.php</a></li>
<li><a href="#trunksrcwpincludesrewritefunctionsphp">trunk/src/wp-includes/rewrite-functions.php</a></li>
<li><a href="#trunktestsphpunittestsrewritephp">trunk/tests/phpunit/tests/rewrite.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 2015-09-30 00:46:15 UTC (rev 34707)
+++ trunk/src/wp-includes/class-wp-rewrite.php 2015-09-30 01:10:03 UTC (rev 34708)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1510,25 +1510,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the top of the rules.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 Array support was added to the `$redirect` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $regex Regular expression to match against request.
- * @param string $redirect URL regex redirects to when regex matches request.
- * @param string $after Optional, default is bottom. Location to place rule.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $regex Regular expression to match against request.
+ * @param string|array $redirect URL regex redirects to when regex matches request, or array
+ * of query vars and values.
+ * @param string $after Optional, default is bottom. Location to place rule.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function add_rule($regex, $redirect, $after = 'bottom') {
- //get everything up to the first ?
- $index = (strpos($redirect, '?') === false ? strlen($redirect) : strpos($redirect, '?'));
- $front = substr($redirect, 0, $index);
- if ( $front != $this->index ) { //it doesn't redirect to WP's index.php
- $this->add_external_rule($regex, $redirect);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function add_rule( $regex, $redirect, $after = 'bottom' ) {
+ if ( is_array( $redirect ) ) {
+ $external = false;
+ $redirect = add_query_arg( $redirect, 'index.php' );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'bottom' == $after)
- $this->extra_rules = array_merge($this->extra_rules, array($regex => $redirect));
- else
- $this->extra_rules_top = array_merge($this->extra_rules_top, array($regex => $redirect));
- //$this->extra_rules[$regex] = $redirect;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $index = false === strpos( $redirect, '?' ) ? strlen( $redirect ) : strpos( $redirect, '?' );
+ $front = substr( $redirect, 0, $index );
+
+ $external = $front != $this->index;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // "external" = it doesn't redirect to index.php
+ if ( $external ) {
+ $this->add_external_rule( $regex, $redirect );
+ } else {
+ if ( 'bottom' == $after ) {
+ $this->extra_rules = array_merge( $this->extra_rules, array( $regex => $redirect ) );
+ } else {
+ $this->extra_rules_top = array_merge( $this->extra_rules_top, array( $regex => $redirect ) );
+ }
+ }
</ins><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></span></pre></div>
<a id="trunksrcwpincludesrewritefunctionsphp"></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-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rewrite-functions.php 2015-09-30 00:46:15 UTC (rev 34707)
+++ trunk/src/wp-includes/rewrite-functions.php 2015-09-30 01:10:03 UTC (rev 34708)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,19 +7,21 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add a straight rewrite rule.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds a straight rewrite rule.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 Array support was added to the `$redirect` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global WP_Rewrite $wp_rewrite
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global WP_Rewrite $wp_rewrite WordPress Rewrite Component.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $regex Regular Expression to match request against.
- * @param string $redirect Page to redirect to.
- * @param string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $regex Regular Expression to match request against.
+ * @param string|array $redirect Page to redirect to, or array of query vars and values.
+ * @param string $after Optional, default is 'bottom'. Where to add rule, can also be 'top'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function add_rewrite_rule($regex, $redirect, $after = 'bottom') {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function add_rewrite_rule( $regex, $redirect, $after = 'bottom' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_rewrite;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wp_rewrite->add_rule($regex, $redirect, $after);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $wp_rewrite->add_rule( $regex, $redirect, $after );
</ins><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></span></pre></div>
<a id="trunktestsphpunittestsrewritephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rewrite.php 2015-09-30 00:46:15 UTC (rev 34707)
+++ trunk/tests/phpunit/tests/rewrite.php 2015-09-30 01:10:03 UTC (rev 34708)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,6 +31,63 @@
</span><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</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">+ /**
+ * @ticket 16840
+ */
+ public function test_add_rule() {
+ global $wp_rewrite;
+
+ $pattern = 'path/to/rewrite/([^/]+)/?$';
+ $redirect = 'index.php?test_var1=$matches[1]&test_var2=1';
+
+ $wp_rewrite->add_rule( $pattern, $redirect );
+
+ $wp_rewrite->flush_rules();
+
+ $rewrite_rules = $wp_rewrite->rewrite_rules();
+
+ $this->assertSame( $redirect, $rewrite_rules[ $pattern ] );
+ }
+
+ /**
+ * @ticket 16840
+ */
+ public function test_add_rule_redirect_array() {
+ global $wp_rewrite;
+
+ $pattern = 'path/to/rewrite/([^/]+)/?$';
+ $redirect = 'index.php?test_var1=$matches[1]&test_var2=1';
+
+ $wp_rewrite->add_rule( $pattern, array(
+ 'test_var1' => '$matches[1]',
+ 'test_var2' => '1'
+ ) );
+
+ $wp_rewrite->flush_rules();
+
+ $rewrite_rules = $wp_rewrite->rewrite_rules();
+
+ $this->assertSame( $redirect, $rewrite_rules[ $pattern ] );
+ }
+
+ /**
+ * @ticket 16840
+ */
+ public function test_add_rule_top() {
+ global $wp_rewrite;
+
+ $pattern = 'path/to/rewrite/([^/]+)/?$';
+ $redirect = 'index.php?test_var1=$matches[1]&test_var2=1';
+
+ $wp_rewrite->add_rule( $pattern, $redirect, 'top' );
+
+ $wp_rewrite->flush_rules();
+
+ $extra_rules_top = $wp_rewrite->extra_rules_top;
+
+ $this->assertContains( $redirect, $extra_rules_top[ $pattern ] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_url_to_postid() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $id = $this->factory->post->create();
</span></span></pre>
</div>
</div>
</body>
</html>