PHP マニュアル: ディレクトリハンドルからエントリを読み込む

説明

stringfalse readdir(resourcenull $dir_handle = null)

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

パラメータ

dir_handle: opendir が事前にオープンしたディレクトリハンドルリソース。ディレクトリハンドルを指定しなかった場合は、 opendir が最後にオープンしたものを使用します。

戻り値

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

警告

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

変更履歴

バージョン	説明
8.0.0	`dir_handle` は、nullable になりました。

例

例1 ディレクトリ内の全てのエントリのリストを得る

以下の例で、readdir の戻り値をどのように調べているかに注目してください。戻り値が false と一致することを、明示的に（値が等しく、かつ型も等しい - 詳細は比較演算子を参照ください）調べています。なぜなら、そうしないと false と評価されてしまうディレクトリエントリ（例: "0" という名前のディレクトリ）があった場合にループがとまってしまうからです。

<?php

if ($handle = opendir('/path/to/files')) {
    echo "Directory handle: $handle\n";
    echo "Entries:\n";

    /* ディレクトリをループする際の正しい方法です */
    while (false !== ($entry = readdir($handle))) {
        echo "$entry\n";
    }

    /* ディレクトリをループする際の「間違った」方法です */
    while ($entry = readdir($handle)) {
        echo "$entry\n";
    }

    closedir($handle);
}
?>

例2 カレントディレクトリの全てのエントリを一覧する。ただし . および .. は取り除く

<?php
if ($handle = opendir('.')) {
    while (false !== ($entry = readdir($handle))) {
        if ($entry != "." && $entry != "..") {
            echo "$entry\n";
        }
    }
    closedir($handle);
}
?>

参考

is_dir
glob
opendir
scandir