【PHP8.x】FOLLOW_SYMLINKS定数の使い方

FOLLOW_SYMLINKS定数は、RecursiveDirectoryIteratorクラスがディレクトリを再帰的に走査する際の挙動を制御する定数です。具体的には、ファイルシステム上に存在する「シンボリックリンク」（他のファイルやディレクトリへの参照）をどのように扱うかを定義します。

この定数をRecursiveDirectoryIteratorクラスのコンストラクタに渡すflags引数として指定することで、イテレータはシンボリックリンクを「辿り」、そのリンクが指す先のディレクトリやファイルも走査の対象に含めるように動作します。例えば、あるディレクトリAの中に、別の場所にあるディレクトリBへのシンボリックリンクが存在する場合、この定数を指定するとディレクトリBの内容も走査対象となります。

一方で、このFOLLOW_SYMLINKS定数を指定しない場合、RecursiveDirectoryIteratorはデフォルトでシンボリックリンク自体は認識しますが、そのリンク先のコンテンツを走査することはありません。つまり、シンボリックリンクを無視して、実体のある物理的なディレクトリ構造のみを辿ります。

したがって、実際の物理パスとは異なる場所にあるコンテンツも一つの走査で網羅したい場合や、仮想的なディレクトリ構造に基づいてファイルを処理したい場合に、この定数は非常に有用です。システムの運用要件やセキュリティポリシーに応じて、ディレクトリ走査の範囲を細かく制御するために利用されます。

Copy
1<?php
2
3$iterator = new RecursiveDirectoryIterator('/path/to/directory', RecursiveDirectoryIterator::FOLLOW_SYMLINKS);
4
5?>

引数なし

引数はありません

int

RecursiveDirectoryIterator::FOLLOW_SYMLINKS は、シンボリックリンクをたどるかどうかを指定する定数で、整数値を返します。