Changeset 56069

Timestamp:

06/27/2023 04:06:16 PM (3 years ago)

Author:

mikeschroder

Message:

Filesystem API: Allow optional inclusion of hidden files in list_files().

Adds a new optional $include_hidden parameter to allow the inclusion of hidden (. prefixed) files.
Defaults to false for backward compatibility.

Props yani.iliev, sabernhardt, costdev, rutviksavsani, zunaid321, azaozz.
Fixes #53659.

Location:

trunk

Files:

• src/wp-admin/includes/file.php (modified) (2 diffs)
• tests/phpunit/tests/functions/listFiles.php (modified) (1 diff)

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

@@ -128 +128 @@
  * @since 2.6.0
  * @since 4.9.0 Added the `$exclusions` parameter.
- *
- * @param string   $folder     Optional. Full path to folder. Default empty.
- * @param int      $levels     Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
- * @param string[] $exclusions Optional. List of folders and files to skip.
+ * @since 6.3.0 Added the `$include_hidden` parameter.
+ *
+ * @param string   $folder         Optional. Full path to folder. Default empty.
+ * @param int      $levels         Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
+ * @param string[] $exclusions     Optional. List of folders and files to skip.
+ * @param bool     $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
+ *                                 Default false.
  * @return string[]|false Array of files on success, false on failure.
  */
-function list_files( $folder = '', $levels = 100, $exclusions = array() ) {
+function list_files( $folder = '', $levels = 100, $exclusions = array(), $include_hidden = false ) {
         if ( empty( $folder ) ) {
                 return false;
@@ -157 +160 @@
 
                         // Skip hidden and excluded files.
-                        if ( '.' === $file[0] || in_array( $file, $exclusions, true ) ) {
+                        if ( ( ! $include_hidden && '.' === $file[0] ) || in_array( $file, $exclusions, true ) ) {
                                 continue;
                         }
 
                         if ( is_dir( $folder . $file ) ) {
-                                $files2 = list_files( $folder . $file, $levels - 1 );
+                                $files2 = list_files( $folder . $file, $levels - 1, array(), $include_hidden );
                                 if ( $files2 ) {
                                         $files = array_merge( $files, $files2 );

trunk/tests/phpunit/tests/functions/listFiles.php

@@ -20 +20 @@
                 $this->assertNotContains( ABSPATH . 'wp-admin/index.php', $admin_files );
         }
+
+        /**
+         * Tests that list_files() optionally includes hidden files.
+         *
+         * @ticket 53659
+         *
+         * @dataProvider data_list_files_should_optionally_include_hidden_files
+         *
+         * @param string   $filename       The name of the hidden file.
+         * @param bool     $include_hidden Whether to include hidden ("." prefixed) files.
+         * @param string[] $exclusions     List of folders and files to skip.
+         * @param bool     $expected       Whether the file should be included in the results.
+         */
+        public function test_list_files_should_optionally_include_hidden_files( $filename, $include_hidden, $exclusions, $expected ) {
+                $test_dir    = get_temp_dir() . 'test-list-files/';
+                $hidden_file = $test_dir . $filename;
+
+                mkdir( $test_dir );
+                touch( $hidden_file );
+
+                $actual = list_files( $test_dir, 100, $exclusions, $include_hidden );
+
+                unlink( $hidden_file );
+                rmdir( $test_dir );
+
+                if ( $expected ) {
+                        $this->assertContains( $hidden_file, $actual, 'The file was not included.' );
+                } else {
+                        $this->assertNotContains( $hidden_file, $actual, 'The file was included.' );
+                }
+        }
+
+        /**
+         * Data provider.
+         *
+         * @return array[]
+         */
+        public function data_list_files_should_optionally_include_hidden_files() {
+                return array(
+                        '$include_hidden = false and no exclusions' => array(
+                                'filename'       => '.hidden_file',
+                                'include_hidden' => false,
+                                'exclusions'     => array(),
+                                'expected'       => false,
+                        ),
+                        '$include_hidden = true and no exclusions'  => array(
+                                'filename'       => '.hidden_file',
+                                'include_hidden' => true,
+                                'exclusions'     => array(),
+                                'expected'       => true,
+                        ),
+                        '$include_hidden = true and an excluded filename' => array(
+                                'filename'       => '.hidden_file',
+                                'include_hidden' => true,
+                                'exclusions'     => array( '.hidden_file' ),
+                                'expected'       => false,
+                        ),
+                );
+        }
 }