【PHP8.x】rewinddir関数の使い方

作成日: 更新日:

rewinddir関数は、opendir関数で開かれたディレクトリストリームの読み取り位置を、ディレクトリの先頭に戻す処理を実行する関数です。通常、readdir関数を繰り返し呼び出すことで、ディレクトリ内のファイルやサブディレクトリを順番に一つずつ取得しますが、rewinddir関数を使用すると、その読み取り位置をリセットし、再び最初のエントリから読み取ることができるようになります。この関数は、引数としてopendir関数が返したディレクトリストリームのリソースを指定します。例えば、ディレクトリ内の全ファイルリストを一度処理した後に、もう一度同じリストを最初から処理する必要が生じた場合などに有効です。ディレクトリを再度opendirで開き直す必要がないため、より効率的なコードを記述できます。処理が成功した場合、この関数は値を返しません(void)が、引数に無効なディレクトリストリームが指定されるなど、処理に失敗した際にはfalseを返します。一連のディレクトリ操作が完了した後は、最終的にclosedir関数を使用してディレクトリストリームを閉じることが推奨されます。

基本的な使い方

構文(syntax)

<?php
$directoryHandle = opendir('/path/to/directory');
rewinddir($directoryHandle);
closedir($directoryHandle);
?>

引数(parameters)

resource $dir_handle

  • resource $dir_handle: rewinddir() 関数が操作するディレクトリポインタ(opendir() 関数によって返されたもの)

戻り値(return)

void

ディレクトリポインタをディレクトリの先頭に移動させます。戻り値はありません。

【PHP8.x】rewinddir関数の使い方 | いっしー@Webエンジニア