summaryrefslogtreecommitdiffstats
path: root/user_guide/helpers
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide/helpers')
-rw-r--r--user_guide/helpers/directory_helper.html7
1 files changed, 5 insertions, 2 deletions
diff --git a/user_guide/helpers/directory_helper.html b/user_guide/helpers/directory_helper.html
index 898b5ac0b..5ebb816f6 100644
--- a/user_guide/helpers/directory_helper.html
+++ b/user_guide/helpers/directory_helper.html
@@ -78,13 +78,16 @@ and builds an array representation of it and all its contained files. Example:</
<p class="important"><strong>Note:</strong> Paths are almost always relative to your main index.php file.</p>
-
-
<p>Sub-folders contained within the directory will be mapped as well. If you wish to map
only the top level directory set the second parameter to <var>true</var> (boolean):</p>
<code>$map = directory_map('./mydirectory/', TRUE);</code>
+<p>By default, hidden files will not be included in the returned array. To override this behavior,
+you may set a third parameter to <var>true</var> (boolean):</p>
+
+<code>$map = directory_map('./mydirectory/', FALSE, TRUE);</code>
+
<p>Each folder name will be an array index, while its contained files will be numerically indexed.
Here is an example of a typical array:</p>