【PHP8.x】rewinddir関数の使い方
rewinddir関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
rewinddir関数は、opendir関数で開かれたディレクトリストリームの読み取り位置を、ディレクトリの先頭に戻す処理を実行する関数です。通常、readdir関数を繰り返し呼び出すことで、ディレクトリ内のファイルやサブディレクトリを順番に一つずつ取得しますが、rewinddir関数を使用すると、その読み取り位置をリセットし、再び最初のエントリから読み取ることができるようになります。この関数は、引数としてopendir関数が返したディレクトリストリームのリソースを指定します。例えば、ディレクトリ内の全ファイルリストを一度処理した後に、もう一度同じリストを最初から処理する必要が生じた場合などに有効です。ディレクトリを再度opendirで開き直す必要がないため、より効率的なコードを記述できます。処理が成功した場合、この関数は値を返しません（void）が、引数に無効なディレクトリストリームが指定されるなど、処理に失敗した際にはfalseを返します。一連のディレクトリ操作が完了した後は、最終的にclosedir関数を使用してディレクトリストリームを閉じることが推奨されます。
構文(syntax)
1<?php 2$directoryHandle = opendir('/path/to/directory'); 3rewinddir($directoryHandle); 4closedir($directoryHandle); 5?>
引数(parameters)
resource $dir_handle
- resource $dir_handle: rewinddir() 関数が操作するディレクトリポインタ（opendir() 関数によって返されたもの）
戻り値(return)
void
ディレクトリポインタをディレクトリの先頭に移動させます。戻り値はありません。
サンプルコード
PHP rewinddirでディレクトリ位置をリセットする
1<?php 2 3// ディレクトリを読み込み位置の先頭に戻すサンプルコード 4$dir = opendir("."); // 現在のディレクトリを開く 5 6if ($dir) { 7 echo "Directory handle: " . $dir . "\n"; 8 9 // ディレクトリの内容を読み込む（例） 10 while (($file = readdir($dir)) !== false) { 11 echo "filename: " . $file . "\n"; 12 } 13 14 rewinddir($dir); // ディレクトリポインタを先頭に戻す 15 16 echo "Rewinding directory...\n"; 17 18 // もう一度ディレクトリの内容を読み込む 19 while (($file = readdir($dir)) !== false) { 20 echo "filename (after rewind): " . $file . "\n"; 21 } 22 23 closedir($dir); // ディレクトリを閉じる 24} else { 25 echo "Could not open directory.\n"; 26} 27 28?>
PHP 8のrewinddir関数は、開いているディレクトリの読み込み位置を先頭に戻すために使用します。この関数は、opendir関数で開いたディレクトリリソースを引数$dir_handleとして受け取ります。
サンプルコードでは、まずopendir(".")で現在のディレクトリを開き、そのディレクトリリソースを$dir変数に格納しています。次に、readdir関数を使ってディレクトリの内容を一度読み込み、ファイル名を表示しています。
ここでrewinddir($dir)を呼び出すことで、ディレクトリの内部ポインタが先頭に戻ります。つまり、次にreaddir関数を呼び出すと、再びディレクトリの最初からファイル名を読み込むことができます。
サンプルコードでは、rewinddirの呼び出し後に、再度readdir関数を使ってディレクトリの内容を読み込み、ファイル名を表示することで、rewinddirが正しく機能していることを確認しています。
最後に、closedir($dir)でディレクトリを閉じ、リソースを解放しています。
rewinddir関数は戻り値を持たない関数（void）です。ディレクトリの読み込み位置をリセットする際に、非常に便利な関数です。ディレクトリの内容を複数回読み込む必要がある場合に活用できます。例えば、特定の条件に合致するファイルを検索した後、別の条件で再度検索する場合などに有効です。
rewinddir()関数は、opendir()で開いたディレクトリの読み込み位置を先頭に戻す関数です。この関数を使うには、まずopendir()でディレクトリを開き、その戻り値（ディレクトリハンドル）をrewinddir()に渡す必要があります。readdir()などでディレクトリの内容を読み込んだ後で、再度最初から読み込みたい場合にrewinddir()を使用します。ディレクトリハンドルは、使い終わったらclosedir()で必ず閉じてください。rewinddir()は、ディレクトリハンドルが無効な場合や、ディレクトリが開かれていない場合には動作しません。また、ファイルシステムによっては、期待通りに動作しない場合があるので注意が必要です。