glob
(PHP 4 >= 4.3.0, PHP 5, PHP 7)
glob — Find pathnames matching a pattern
Description
$pattern
[, int $flags
= 0
] ) : array
The glob() function searches for all the pathnames
matching pattern
according to the rules used by
the libc glob() function, which is similar to the rules used by common
shells.
Parameters
-
pattern
-
The pattern. No tilde expansion or parameter substitution is done.
Special characters:
- * - Matches zero of more characters.
- ? - Matches exactly one character (any character).
- [...] - Matches one character from a group of characters. If the first character is !, matches any character not in the group.
- ... - Matches all the subdirectories, recursively.
-
\ - Escapes the following character,
except when the
GLOB_NOESCAPE
flag is used.
-
flags
-
Valid flags:
-
GLOB_MARK
- Adds a slash to each directory returned -
GLOB_NOSORT
- Return files as they appear in the directory (no sorting). When this flag is not used, the pathnames are sorted alphabetically -
GLOB_NOCHECK
- Return the search pattern if no files matching it were found -
GLOB_NOESCAPE
- Backslashes do not quote metacharacters -
GLOB_BRACE
- Expands {a,b,c} to match 'a', 'b', or 'c' -
GLOB_ONLYDIR
- Return only directory entries which match the pattern -
GLOB_ERR
- Stop on read errors (like unreadable directories), by default errors are ignored.
-
Return Values
Returns an array containing the matched files/directories, an empty array
if no file matched or FALSE
on error.
Note:
On some systems it is impossible to distinguish between empty match and an error.
Examples
Example #1 Convenient way how glob() can replace opendir() and friends.
<?php
foreach (glob("*.txt") as $filename) {
echo "$filename size " . filesize($filename) . "\n";
}
?>
The above example will output something similar to:
funclist.txt size 44686 funcsummary.txt size 267625 quickref.txt size 137820
Notes
Note: This function will not work on remote files as the file to be examined must be accessible via the server's filesystem.
Note: This function isn't available on some systems (e.g. old Sun OS).
Note: The
GLOB_BRACE
flag is not available on some non GNU systems, like Solaris.
See Also
- opendir() - Open directory handle
- readdir() - Read entry from directory handle
- closedir() - Close directory handle
- fnmatch() - Match filename against a pattern
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-glob.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.