readdir

(PHP 4, PHP 5, PHP 7, PHP 8)

readdirディレクトリハンドルからエントリを読み込む

説明

readdir(?resource $dir_handle = null): string|false

ディレクトリから次のエントリの名前を返します。 エントリ名はファイルシステム上に格納されている順番で返されます。

パラメータ

dir_handle
opendir() が事前にオープンした ディレクトリハンドルを示す resourcedir_handlenull の場合は、 opendir() が最後にオープンしたものを使用します。

戻り値

成功した場合にエントリ名、失敗した場合に false を返します。

警告

この関数は論理値 false を返す可能性がありますが、false として評価される値を返す可能性もあります。 詳細については 論理値の セクションを参照してください。この関数の返り値を調べるには ===演算子 を 使用してください。

変更履歴

バージョン 説明
8.5.0 dir_handlenull を指定することは、推奨されなくなりました。 代わりに、最後にオープンしたディレクトリハンドルを明示的に指定すべきです。
8.0.0 dir_handle は、nullable になりました

完全なサンプルコードは、 opendir() のドキュメントを参照ください。

参考

  • opendir() - ディレクトリハンドルをオープンする
  • rewinddir() - ディレクトリハンドルを元に戻す
  • closedir() - ディレクトリハンドルをクローズする
  • dir() - ディレクトリクラスのインスタンスを返す
  • is_dir() - ファイルがディレクトリかどうかを調べる
  • glob() - パターンにマッチするパス名を探す
  • scandir() - 指定されたパスのファイルとディレクトリのリストを取得する