Changeset 55990 for trunk/src/wp-admin/includes/file.php

Timestamp:

06/22/2023 02:55:47 PM (5 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Replace usage of substr() with str_starts_with() and str_ends_with().

str_starts_with() and str_ends_with() were introduced in PHP 8.0 to perform a case-sensitive check indicating if the string to search in (haystack) begins or ends with the given substring (needle).

WordPress core includes a polyfill for these functions on PHP < 8.0 as of WordPress 5.9.

This commit uses str_starts_with() and str_ends_with() in core files where appropriate:

• $needle === substr( $string, 0, $length ), where $length is the length of $needle, is replaced with str_starts_with( $haystack, $needle ).
• $needle === substr( $string, $offset ), where $offset is negative and the absolute value of $offset is the length of $needle, is replaced with str_ends_with( $haystack, $needle ).

This aims to make the code more readable and consistent, as well as better aligned with modern development practices.

Follow-up to [52039], [52040], [52326], [55703], [55710], [55987], [55988].

Props Soean, spacedmonkey, Clorith, ocean90, azaozz, sabernhardt, SergeyBiryukov.
Fixes #58220.

File:

• trunk/src/wp-admin/includes/file.php (modified) (6 diffs)

trunk/src/wp-admin/includes/file.php

@@ -1254 +1254 @@
             $signature_url = false;
 
-            if ( is_string( $url_path ) && ( '.zip' === substr( $url_path, -4 ) || '.tar.gz' === substr( $url_path, -7 ) ) ) {
+            if ( is_string( $url_path ) && ( str_ends_with( $url_path, '.zip' ) || str_ends_with( $url_path, '.tar.gz' ) ) ) {
                 $signature_url = str_replace( $url_path, $url_path . '.sig', $url );
             }
@@ -1647 +1647 @@
         }
 
-        if ( '__MACOSX/' === substr( $info['name'], 0, 9 ) ) { // Skip the OS X-created __MACOSX directory.
+        if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
             continue;
         }
@@ -1660 +1660 @@
         $dirname = dirname( $info['name'] );
 
-        if ( '/' === substr( $info['name'], -1 ) ) {
+        if ( str_ends_with( $info['name'], '/' ) ) {
             // Directory.
             $needed_dirs[] = $to . untrailingslashit( $info['name'] );
@@ -1727 +1727 @@
         }
 
-        if ( '/' === substr( $info['name'], -1 ) ) { // Directory.
+        if ( str_ends_with( $info['name'], '/' ) ) { // Directory.
             continue;
         }
 
-        if ( '__MACOSX/' === substr( $info['name'], 0, 9 ) ) { // Don't extract the OS X-created __MACOSX directory files.
+        if ( str_starts_with( $info['name'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
             continue;
         }
@@ -1801 +1801 @@
     // Determine any children directories needed (From within the archive).
     foreach ( $archive_files as $file ) {
-        if ( '__MACOSX/' === substr( $file['filename'], 0, 9 ) ) { // Skip the OS X-created __MACOSX directory.
+        if ( str_starts_with( $file['filename'], '__MACOSX/' ) ) { // Skip the OS X-created __MACOSX directory.
             continue;
         }
@@ -1867 +1867 @@
         }
 
-        if ( '__MACOSX/' === substr( $file['filename'], 0, 9 ) ) { // Don't extract the OS X-created __MACOSX directory files.
+        if ( str_starts_with( $file['filename'], '__MACOSX/' ) ) { // Don't extract the OS X-created __MACOSX directory files.
             continue;
         }