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

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.

File:

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

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 );