<!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>[51622] trunk: Code Modernization: Check the return type of `parse_url()` in `WP::parse_request()`.</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/51622">51622</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/51622","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-08-16 20:16:13 +0000 (Mon, 16 Aug 2021)</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'>Code Modernization: Check the return type of `parse_url()` in `WP::parse_request()`.
As per the PHP manual:
> If the `component` parameter is omitted, an associative array is returned.
> If the `component` parameter is specified, `parse_url()` returns a string (or an int, in the case of `PHP_URL_PORT`) instead of an array. If the requested component doesn't exist within the given URL, `null` will be returned.
Reference: [https://www.php.net/manual/en/function.parse-url.php#refsect1-function.parse-url-returnvalues PHP Manual: parse_url(): Return Values]
In this case, `parse_url()` is called with the `PHP_URL_PATH` as `$component`. This will return `null` in the majority of cases, as - ex{U+0441}ept for subdirectory-based sites - `home_url()` returns a URL without the trailing slash, like `http://example.org`.
The return value of `parse_url()` was subsequently passed to `trim()`, leading to a `trim(): Passing null to parameter <a href="https://core.trac.wordpress.org/ticket/1">#1</a> ($string) of type string is deprecated` notice on PHP 8.1.
Fixed by adjusting the logic flow to:
* Only pass the return value of `parse_url()` to follow-on functions if it makes sense, i.e. if it isn't `null`, nor an empty string.
* Preventing calls to `preg_replace()` and `trim()` further down in the function logic flow, when `preg_replace()`/`trim()` would have nothing to do anyhow.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/25617">[25617]</a>.
Props jrf, hellofromTonya, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/53635">#53635</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpphp">trunk/src/wp-includes/class-wp.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/tests/wp/</li>
<li><a href="#trunktestsphpunittestswpparseRequestphp">trunk/tests/phpunit/tests/wp/parseRequest.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp.php 2021-08-16 18:41:12 UTC (rev 51621)
+++ trunk/src/wp-includes/class-wp.php 2021-08-16 20:16:13 UTC (rev 51622)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -170,9 +170,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> list( $req_uri ) = explode( '?', $_SERVER['REQUEST_URI'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $self = $_SERVER['PHP_SELF'];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $home_path = trim( parse_url( home_url(), PHP_URL_PATH ), '/' );
- $home_path_regex = sprintf( '|^%s|i', preg_quote( $home_path, '|' ) );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $home_path = parse_url( home_url(), PHP_URL_PATH );
+ $home_path_regex = '';
+ if ( is_string( $home_path ) && '' !== $home_path ) {
+ $home_path = trim( $home_path, '/' );
+ $home_path_regex = sprintf( '|^%s|i', preg_quote( $home_path, '|' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Trim path info from the end and the leading home path from the front.
</span><span class="cx" style="display: block; padding: 0 10px"> * For path info requests, this leaves us with the requesting filename, if any.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -180,15 +185,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $req_uri = str_replace( $pathinfo, '', $req_uri );
</span><span class="cx" style="display: block; padding: 0 10px"> $req_uri = trim( $req_uri, '/' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $req_uri = preg_replace( $home_path_regex, '', $req_uri );
- $req_uri = trim( $req_uri, '/' );
</del><span class="cx" style="display: block; padding: 0 10px"> $pathinfo = trim( $pathinfo, '/' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $pathinfo = preg_replace( $home_path_regex, '', $pathinfo );
- $pathinfo = trim( $pathinfo, '/' );
</del><span class="cx" style="display: block; padding: 0 10px"> $self = trim( $self, '/' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $self = preg_replace( $home_path_regex, '', $self );
- $self = trim( $self, '/' );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $home_path_regex ) ) {
+ $req_uri = preg_replace( $home_path_regex, '', $req_uri );
+ $req_uri = trim( $req_uri, '/' );
+ $pathinfo = preg_replace( $home_path_regex, '', $pathinfo );
+ $pathinfo = trim( $pathinfo, '/' );
+ $self = preg_replace( $home_path_regex, '', $self );
+ $self = trim( $self, '/' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // The requested permalink is in $pathinfo for path info requests and
</span><span class="cx" style="display: block; padding: 0 10px"> // $req_uri for other requests.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $pathinfo ) && ! preg_match( '|^.*' . $wp_rewrite->index . '$|', $pathinfo ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestswpparseRequestphp"></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/wp/parseRequest.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/wp/parseRequest.php (rev 0)
+++ trunk/tests/phpunit/tests/wp/parseRequest.php 2021-08-16 20:16:13 UTC (rev 51622)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,42 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group wp
+ * @covers WP::parse_request
+ */
+class Tests_WP_ParseRequest extends WP_UnitTestCase {
+ /**
+ * @var WP
+ */
+ protected $wp;
+
+ public function set_up() {
+ parent::set_up();
+ $this->wp = new WP();
+ }
+
+ /**
+ * Test that PHP 8.1 "passing null to non-nullable" deprecation notice
+ * is not thrown when the home URL has no path/trailing slash (default setup).
+ *
+ * Note: This does not test the actual functioning of the parse_request() method.
+ * It just and only tests for/against the deprecation notice.
+ *
+ * @ticket 53635
+ */
+ public function test_no_deprecation_notice_when_home_url_has_no_path() {
+ // Make sure rewrite rules are not empty.
+ $this->set_permalink_structure( '/%year%/%monthnum%/%postname%/' );
+
+ // Make sure the test will function independently of whatever the test user set in wp-tests-config.php.
+ add_filter(
+ 'home_url',
+ static function ( $url ) {
+ return 'http://example.org';
+ }
+ );
+
+ $this->wp->parse_request();
+ $this->assertSame( '', $this->wp->request );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/wp/parseRequest.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>