[Finder docs] Add early directory prunning filter support

Co-authored-by: Alexis Lefebvre <alexislefebvre@gmail.com>
symfony · Jul 12, 2023 · 4b08ee6 · 4b08ee6
1 parent 83aaa26
commit 4b08ee6
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/components/finder.rst b/components/finder.rst
@@ -329,6 +329,12 @@ it is called with the file as a :class:`Symfony\\Component\\Finder\\SplFileInfo`
 instance. The file is excluded from the result set if the Closure returns
 ``false``.
 
+.. versionadded:: 6.4
+
+Since Symfony 6.4, a filter can prune directories early, pass ``true`` as the second
+parameter for the ``filter()`` method and when the Closure returns ``false`` the deeper
+levels will not be traversed.
+
 Sorting Results
 ---------------