Changeset 57707

Timestamp:

02/25/2024 10:15:11 PM (7 months ago)

Author:

peterwilsoncc

Message:

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 #59448.

Location:

trunk

Files:

• src/wp-includes/functions.php (modified) (1 diff)
• tests/phpunit/tests/functions/isWpVersionCompatible.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-plugins-controller.php (modified) (2 diffs)

trunk/src/wp-includes/functions.php

@@ -8764 +8764 @@
     list( $version ) = explode( '-', $wp_version );
 
+    if ( is_string( $required ) ) {
+        $trimmed = trim( $required );
+
+        if ( substr_count( $trimmed, '.' ) > 1 && str_ends_with( $trimmed, '.0' ) ) {
+            $required = substr( $trimmed, 0, -2 );
+        }
+    }
+
     return empty( $required ) || version_compare( $version, $required, '>=' );
 }

trunk/tests/phpunit/tests/functions/isWpVersionCompatible.php

@@ -44 +44 @@
         return array(
             // Happy paths.
-            'the same version'          => array(
+            'the same version'                => array(
                 'required' => $wp_version,
                 'expected' => true,
             ),
-            'a lower required version'  => array(
-                'required' => $lower_version,
-                'expected' => true,
-            ),
-            'a higher required version' => array(
-                'required' => $higher_version,
-                'expected' => false,
+            'a lower required version'        => array(
+                'required' => $lower_version,
+                'expected' => true,
+            ),
+            'a higher required version'       => array(
+                'required' => $higher_version,
+                'expected' => false,
+            ),
+
+            // 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,
             ),
 
             // Falsey values.
-            'false'                     => array(
+            'false'                           => array(
                 'required' => false,
                 'expected' => true,
             ),
-            'null'                      => array(
+            'null'                            => array(
                 'required' => null,
                 'expected' => true,
             ),
-            '0 int'                     => array(
+            '0 int'                           => array(
                 'required' => 0,
                 'expected' => true,
             ),
-            '0.0 float'                 => array(
+            '0.0 float'                       => array(
                 'required' => 0.0,
                 'expected' => true,
             ),
-            '0 string'                  => array(
+            '0 string'                        => array(
                 'required' => '0',
                 'expected' => true,
             ),
-            'empty string'              => array(
+            'empty string'                    => array(
                 'required' => '',
                 'expected' => true,
             ),
-            'empty array'               => array(
+            'empty array'                     => array(
                 'required' => array(),
+                'expected' => true,
+            ),
+        );
+    }
+
+    /**
+     * 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,
             ),

trunk/tests/phpunit/tests/rest-api/rest-plugins-controller.php

@@ -1022 +1022 @@
         $this->assertSame( $network_only, $data['network_only'] );
         $this->assertSame( '5.6.0', $data['requires_php'] );
-        $this->assertSame( '5.4.0', $data['requires_wp'] );
+        $this->assertSame( '5.4', $data['requires_wp'] );
         $this->assertSame( 'test-plugin', $data['textdomain'] );
     }
@@ -1150 +1150 @@
  * Text Domain: test-plugin
  * Requires PHP: 5.6.0
- * Requires at least: 5.4.0{$network}
+ * Requires at least: 5.4{$network}
  */
 PHP;