PHP | dir()函数

介绍

dir()函数是PHP内置的一个函数，用于返回指定目录中的文件和子目录的列表。

使用语法

public dir(string $directory, resource $context = null)

$directory 参数指定了要查看的目录的路径，可以是绝对路径或相对路径。
$context 参数可以用于设置目录上下文，通常用于指定目录操作的附加选项。

返回值

dir() 函数返回一个 Directory 对象，该对象包含了目录中的文件和子目录的列表。可以使用 readdir() 函数从该对象中读取文件和子目录的名字。

示例

以下示例演示了如何使用 dir() 函数列出指定目录中的文件和子目录。

$directory = './my_dir';  // 指定要查看的目录
$dir = dir($directory);  // 使用 dir() 函数打开目录并返回 Directory 对象

// 读取目录中的文件和子目录，并输出
while (($file = $dir->read()) !== false) {
    echo $file . "\n";
}

$dir->close();  // 关闭目录

注意事项

• dir() 函数在 PHP 7.0.0 版本被废弃，推荐使用更现代的 opendir() 函数代替。但在实际开发中，仍有一些旧代码使用 dir() 函数，因此我们还需要了解它的使用方法。
• 建议使用 is_dir() 函数先检查指定的路径是否是一个目录，以避免出现不可预料的错误。
• 若要在目录操作后关闭该目录句柄，请使用 closedir() 函数。
• 对于大型目录，该函数可能会有性能问题。因此在处理大型目录时，建议使用其他方法来获取目录中的文件列表。

总结

通过 dir() 函数，我们可以方便地获取指定目录中的文件和子目录。虽然在新的 PHP 版本中已不再推荐使用该函数，但了解和掌握其用法对于阅读旧代码和与其他开发者协作仍然是有用的。

参考链接：PHP: dir - Manual