<!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>[47843] branches/5.4/tests/phpunit/tests/rest-api.php: REST API: Ensure proper namespacing when registering routes.</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 { white-space: pre-line; 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/47843">47843</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/47843","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-05-22 20:58:50 +0000 (Fri, 22 May 2020)</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'>REST API: Ensure proper namespacing when registering routes.
The PR will corerce routes that have a leading slash and throwing a _doing_it_wrong notice while ensuring a proper namespace.
This brings the changes from <a href="https://core.trac.wordpress.org/changeset/47842">[47842]</a> to the 5.4 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/49749">#49749</a>.
Props TimothyBlynJacobs, skarabeq, afercia, skithund.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches54srcwpincludesrestapiphp">branches/5.4/src/wp-includes/rest-api.php</a></li>
<li><a href="#branches54testsphpunittestsrestapiphp">branches/5.4/tests/phpunit/tests/rest-api.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches54">branches/5.4/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/5.4
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/5.4 2020-05-22 20:46:03 UTC (rev 47842)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/5.4 2020-05-22 20:58:50 UTC (rev 47843)
</ins><a id="branches54"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/5.4</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:47432,47436,47439,47441,47443-47444,47449,47455-47456,47458-47459,47462,47475-47476,47495,47500,47502,47511,47513,47515,47517,47521,47532,47536-47537,47539,47547,47549,47555,47558,47560,47564,47568,47576,47578,47580,47586,47590-47591,47594,47608-47609,47633-47635,47637-47638,47663-47664,47689,47699,47730,47734,47751,47784,47790,47795-47796,47799,47801,47820,47832,47838
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:47432,47436,47439,47441,47443-47444,47449,47455-47456,47458-47459,47462,47475-47476,47495,47500,47502,47511,47513,47515,47517,47521,47532,47536-47537,47539,47547,47549,47555,47558,47560,47564,47568,47576,47578,47580,47586,47590-47591,47594,47608-47609,47633-47635,47637-47638,47663-47664,47689,47699,47730,47734,47751,47784,47790,47795-47796,47799,47801,47820,47832,47838,47842
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches54srcwpincludesrestapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.4/src/wp-includes/rest-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.4/src/wp-includes/rest-api.php 2020-05-22 20:46:03 UTC (rev 47842)
+++ branches/5.4/src/wp-includes/rest-api.php 2020-05-22 20:58:50 UTC (rev 47843)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -44,6 +44,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ $clean_namespace = trim( $namespace, '/' );
+
+ if ( $clean_namespace !== $namespace ) {
+ _doing_it_wrong( __FUNCTION__, __( 'Namespace must not start or end with a slash.' ), '5.4.2' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! did_action( 'rest_api_init' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _doing_it_wrong(
</span><span class="cx" style="display: block; padding: 0 10px"> 'register_rest_route',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,8 +90,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $arg_group['args'] = array_merge( $common_args, $arg_group['args'] );
</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">- $full_route = '/' . trim( $namespace, '/' ) . '/' . trim( $route, '/' );
- rest_get_server()->register_route( $namespace, $full_route, $args, $override );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $full_route = '/' . $clean_namespace . '/' . trim( $route, '/' );
+ rest_get_server()->register_route( $clean_namespace, $full_route, $args, $override );
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</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="branches54testsphpunittestsrestapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.4/tests/phpunit/tests/rest-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.4/tests/phpunit/tests/rest-api.php 2020-05-22 20:46:03 UTC (rev 47842)
+++ branches/5.4/tests/phpunit/tests/rest-api.php 2020-05-22 20:58:50 UTC (rev 47843)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -956,6 +956,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected, rest_parse_embed_param( $embed ) );
</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 49749
+ */
+ public function test_register_route_with_invalid_namespace() {
+ $this->setExpectedIncorrectUsage( 'register_rest_route' );
+
+ register_rest_route(
+ '/my-namespace/v1/',
+ '/my-route',
+ array(
+ 'callback' => '__return_true',
+ )
+ );
+
+ $routes = rest_get_server()->get_routes( 'my-namespace/v1' );
+ $this->assertCount( 2, $routes );
+
+ $this->assertTrue( rest_do_request( '/my-namespace/v1/my-route' )->get_data() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function _dp_rest_parse_embed_param() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="cx" style="display: block; padding: 0 10px"> array( true, '' ),
</span></span></pre>
</div>
</div>
</body>
</html>