PHP glob() Function

❮ PHP Filesystem Reference

Example

Return an array of filenames or directories that matches the specified pattern:

<?php
print_r(glob("*.txt"));
?>

The output of the code above could be:

Array (
[0] => target.txt
[1] => source.txt
[2] => test.txt
[3] => test2.txt
)

Definition and Usage

The glob() function returns an array of filenames or directories matching a specified pattern.

Syntax

glob( pattern, flags)

Parameter Values

Parameter	Description
pattern	Required. Specifies the pattern to search for
flags	Optional. Specifies special settings. Possible values: GLOB_MARK - Adds a slash to each item returned GLOB_NOSORT - Return files as they appear in the directory (unsorted) GLOB_NOCHECK - Returns the search pattern if no match 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 directories which match the pattern GLOB_ERR - (added in PHP 5.1) Stop on errors (errors are ignored by default)

Parameter

Description

pattern

Required. Specifies the pattern to search for

flags

Optional. Specifies special settings.

Possible values:

GLOB_MARK - Adds a slash to each item returned
GLOB_NOSORT - Return files as they appear in the directory (unsorted)
GLOB_NOCHECK - Returns the search pattern if no match 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 directories which match the pattern
GLOB_ERR - (added in PHP 5.1) Stop on errors (errors are ignored by default)

Technical Details

Return Value:	An array of files/directories that matches the pattern, FALSE on failure
PHP Version:	4.3+
PHP Changelog:	PHP 5.1: GLOB_ERR value added to the flags parameter

More Examples

Example

Return an array of filenames or directories that matches the specified pattern:

<?php
print_r(glob("*.*"));
?>

The output of the code above could be:

Array (
[0] => contacts.csv
[1] => default.html
[2] => target.txt
[3] => source.txt
[4] => tem1.tmp
[5] => test.htm
[6] => test.ini
[7] => test.html
[8] => test.txt
[9] => test2.txt
)

❮ PHP Filesystem Reference