<!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>[57707] trunk: Upgrade/Install: Normalize major versions in `is_wp_version_compatible()`.</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/57707">57707</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/57707","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-02-25 22:15:11 +0000 (Sun, 25 Feb 2024)</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'>Upgrade/Install: Normalize major versions in `is_wp_version_compatible()`.
Modify `is_wp_version_compatible()` to return the expected result for major WordPress versions formatted as either `x.x` or `x.x.0` (for example `6.5` and `6.5.0`).
The WordPress project currently documents major version numbers in both formats leading to confusion for developers using the `is_wp_version_compatible()` function. As the PHP function `version_compare()` treats `x.x` and `x.x.0` as different version numbers this leads to unexpected results in the WP function.
This change removes a trailing `.0` from major version numbers to account for the WordPress project using the two formats interchangeably.
Props afragen, azaozz, costdev, joemcgill, jorbin, kkmuffme, sessioncookiemonster, swissspidy, wazeter.
Fixes <a href="https://core.trac.wordpress.org/ticket/59448">#59448</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsfunctionsisWpVersionCompatiblephp">trunk/tests/phpunit/tests/functions/isWpVersionCompatible.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpluginscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-plugins-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2024-02-25 15:25:49 UTC (rev 57706)
+++ trunk/src/wp-includes/functions.php 2024-02-25 22:15:11 UTC (rev 57707)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8763,6 +8763,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Strip off any -alpha, -RC, -beta, -src suffixes.
</span><span class="cx" style="display: block; padding: 0 10px"> list( $version ) = explode( '-', $wp_version );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_string( $required ) ) {
+ $trimmed = trim( $required );
+
+ if ( substr_count( $trimmed, '.' ) > 1 && str_ends_with( $trimmed, '.0' ) ) {
+ $required = substr( $trimmed, 0, -2 );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return empty( $required ) || version_compare( $version, $required, '>=' );
</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="trunktestsphpunittestsfunctionsisWpVersionCompatiblephp"></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/functions/isWpVersionCompatible.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/functions/isWpVersionCompatible.php 2024-02-25 15:25:49 UTC (rev 57706)
+++ trunk/tests/phpunit/tests/functions/isWpVersionCompatible.php 2024-02-25 22:15:11 UTC (rev 57707)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,45 +43,55 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="cx" style="display: block; padding: 0 10px"> // Happy paths.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'the same version' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'the same version' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => $wp_version,
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'a lower required version' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'a lower required version' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => $lower_version,
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'a higher required version' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'a higher required version' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => $higher_version,
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => 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">+ // Acceptable versions containing '.0'.
+ 'correct version ending with x.0' => array(
+ 'required' => '5.0',
+ 'expected' => true,
+ ),
+ 'correct version with x.0.x in middle of version' => array(
+ 'required' => '5.0.1',
+ 'expected' => true,
+ ),
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Falsey values.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'false' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'false' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'null' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'null' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '0 int' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '0 int' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '0.0 float' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '0.0 float' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => 0.0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '0 string' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '0 string' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => '0',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'empty string' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'empty string' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'empty array' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'empty array' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'required' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -89,6 +99,85 @@
</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">+ * Tests that is_wp_version_compatible() gracefully handles incorrect version numbering.
+ *
+ * @dataProvider data_is_wp_version_compatible_should_gracefully_handle_trailing_point_zero_version_numbers
+ *
+ * @ticket 59448
+ *
+ * @param mixed $required The minimum required WordPress version.
+ * @param string $wp The value for the $wp_version global variable.
+ * @param bool $expected The expected result.
+ */
+ public function test_is_wp_version_compatible_should_gracefully_handle_trailing_point_zero_version_numbers( $required, $wp, $expected ) {
+ global $wp_version;
+ $original_version = $wp_version;
+ $wp_version = $wp;
+
+ $actual = is_wp_version_compatible( $required );
+
+ // Reset the version before the assertion in case of failure.
+ $wp_version = $original_version;
+
+ $this->assertSame( $expected, $actual, 'The expected result was not returned.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_is_wp_version_compatible_should_gracefully_handle_trailing_point_zero_version_numbers() {
+ return array(
+ 'an incorrect trailing .0 and the same version' => array(
+ 'required' => '5.2.0',
+ 'wp' => '5.2',
+ 'expected' => true,
+ ),
+ 'an incorrect trailing .0 and the same x.0 version' => array(
+ 'required' => '5.0.0',
+ 'wp' => '5.0',
+ 'expected' => true,
+ ),
+ 'an incorrect trailing .0 and space and same x.0 version' => array(
+ 'required' => '5.0.0 ',
+ 'wp' => '5.0',
+ 'expected' => true,
+ ),
+ 'incorrect preceding and trailing spaces trailing .0' => array(
+ 'required' => ' 5.0.0 ',
+ 'wp' => '5.0',
+ 'expected' => true,
+ ),
+ 'an incorrect trailing .0 on x.0.x version' => array(
+ 'required' => '5.0.1.0',
+ 'wp' => '5.0.1',
+ 'expected' => true,
+ ),
+ 'an incorrect trailing .0 and an earlier version' => array(
+ 'required' => '5.0.0',
+ 'wp' => '4.0',
+ 'expected' => false,
+ ),
+ 'an incorrect trailing .0 and an earlier x.0 version' => array(
+ 'required' => '5.0.0',
+ 'wp' => '4.0',
+ 'expected' => false,
+ ),
+ 'an incorrect trailing .0 and a later version' => array(
+ 'required' => '5.0.0',
+ 'wp' => '6.0',
+ 'expected' => true,
+ ),
+ 'an incorrect trailing .0 and a later x.0 version' => array(
+ 'required' => '5.0.0',
+ 'wp' => '6.0',
+ 'expected' => true,
+ ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests is_wp_version_compatible() with development versions.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_is_wp_version_compatible_with_development_versions
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpluginscontrollerphp"></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/rest-api/rest-plugins-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-plugins-controller.php 2024-02-25 15:25:49 UTC (rev 57706)
+++ trunk/tests/phpunit/tests/rest-api/rest-plugins-controller.php 2024-02-25 22:15:11 UTC (rev 57707)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1021,7 +1021,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'My ‘Cool’ Plugin <cite>By <a href="https://wordpress.org/">WordPress.org</a>.</cite>', $data['description']['rendered'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $network_only, $data['network_only'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '5.6.0', $data['requires_php'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( '5.4.0', $data['requires_wp'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( '5.4', $data['requires_wp'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'test-plugin', $data['textdomain'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1149,7 +1149,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Author URI: https://wordpress.org/
</span><span class="cx" style="display: block; padding: 0 10px"> * Text Domain: test-plugin
</span><span class="cx" style="display: block; padding: 0 10px"> * Requires PHP: 5.6.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Requires at least: 5.4.0{$network}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Requires at least: 5.4{$network}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> PHP;
</span><span class="cx" style="display: block; padding: 0 10px"> wp_mkdir_p( WP_PLUGIN_DIR . '/test-plugin' );
</span></span></pre>
</div>
</div>
</body>
</html>