PHPで指定したディレクトリ内のファイル一覧を取得する方法を現役エンジニアが解説【初心者向け】

初心者向けにPHPで指定したディレクトリ内のファイル一覧を取得する方法について現役エンジニアが解説しています。PHPでファイル一覧を取得するにはglob関数を使います。glob関数とは、パターンにマッチしたパス名を探す関数です。glob関数でのパスの指定方法などについて解説します。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事が4,000以上あります。現役エンジニアの方はこちらをご覧ください。

今回は、PHPで指定したディレクトリ内のファイル一覧を取得する方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

 

PHPについてそもそもよく分からないという方は、PHPとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、PHP/Laravel講座の内容をもとに紹介しています。

 

田島悠介

今回は、PHPに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

PHPで指定したディレクトリ内のファイル一覧を取得する方法について詳しく説明していくね!

大石ゆかり

お願いします!

 
この記事は、PHPのglob関数を使用して、ディレクトリ内のファイル一覽を取得する方法について解説した記事です。

PHPの開発にまだ慣れていない方でも理解できる内容になっています。
 

目次

 

glob関数とは

PHPのglob関数は、パターンにマッチしたパス名を探す関数です。

また、ワイルドカード(任意の文字列を表す記号 ex.「*」や「?」)を使用することで、ディレクトリ内のファイルの一覧を取得できます。
 

[PR] PHPのプログラミングで挫折しない学習方法を動画で公開中

glob関数でディレクトリを指定してファイル一覧を取得する方法

それでは、glob関数を使用してディレクトリ内のファイル一覧を取得する方法について解説します。

使用方法:

glob($パスのパターン [, $glob関数専用のフラグ])

glob関数の第一引数には、ワイルドカードなどを交えたパスのパターン文字列を渡します。

第二引数には任意で、glob関数専用のフラグを渡すことが可能です。
フラグには、「GLOB_ONLYDIR」や「GLOB_ERR」などのPHPで用意された定数があります。

GLOB_ONLYDIRは、パターンにマッチしたディレクトリのみを返却するフラグで、GLOB_ERRは、ディレクトリが読み込めないなどのエラーが発生した際に、プログラムを停止するようにできます。(デフォルトは停止しないようになっています)

このようにフラグを渡すことで、glob関数の処理内容を制御できます。

返却値は、第一引数のパターンにマッチしたディレクトリやファイルの一覧が配列となって返却されます。マッチするファイルがなかった場合は、空の配列([])、処理が失敗した場合はboolean値のFALSEを返却します。

ファイルの一覽を取得する際は、第一引数に渡す「$パスのパターン」に”*.*”というパスの文字列を渡します。これはワイルドカード「*」を使用して「任意のファイル名.任意の拡張子」のファイルを取得するように指定しています。

「任意のファイル名.任意の拡張子」のファイルとはすべてのファイルに当てはまるパターンのため、ディレクトリ内のすべてのファイルを取得できます。
 

実際に書いてみよう

それでは、実際にglob関数を使用してファイルの一覽を取得する例を見ていきましょう。

ディレクトリ構造:

サンプルコード(glob.php):

<?php
// directory配下のファイル一覽を取得する
$files = glob("directory/*.*");
echo "========= ALL files =========\n";
print_r($files);
echo("\n");

// directory配下のjsonファイル一覽を取得する
$json_files = glob("directory/*.json");
echo "========= JSON files =========\n";
print_r($json_files);
echo("\n");

// directory配下のtxtファイル一覽を取得する
$txt_files = glob("directory/*.txt");
echo "========= txt files =========\n";
print_r($txt_files);
echo("\n");

// directory配下の「foo」と名付けられたファイル一覽を取得する
$foo_files = glob("directory/foo.*");
echo "========= foo files =========\n";
print_r($foo_files);
?>

 

実行結果:

========= ALL files =========
Array
(
 [0] => directory/bar.json
 [1] => directory/bar.txt
 [2] => directory/baz.json
 [3] => directory/baz.txt
 [4] => directory/foo.json
 [5] => directory/foo.txt
)

========= JSON files =========
Array
(
 [0] => directory/bar.json
 [1] => directory/baz.json
 [2] => directory/foo.json
)

========= txt files =========
Array
(
 [0] => directory/bar.txt
 [1] => directory/baz.txt
 [2] => directory/foo.txt
)

========= foo files =========
Array
(
 [0] => directory/foo.json
 [1] => directory/foo.txt
)

上記の例では、glob関数を使用して、ディレクトリ「directory」配下のファイル一覽を相対パスを指定して取得しています。

実行結果の1つ目の出力では、glob関数の引数に渡す相対パスを「*.*」としてdirectory配下にあるすべてのファイル一覽を取得しています。

2つ目の出力では、glob関数の引数に渡す相対パスを「*.json」としてdirectory配下にある拡張子が「json」のjsonファイルを指定して一覽を取得しています。

3つ目の出力では、glob関数の引数に渡す相対パスを「*.txt」としてdirectory配下にある拡張子が「txt」のテキストファイルを指定して一覽を取得しています。

4つ目の出力では、glob関数の引数に渡す相対パスを「foo.*」としてdirectory配下にある「foo」の名前がついてファイルの一覽を取得しています。
 

まとめ

以上、glob関数を使用して、ディレクトリ内のファイルの一覽を取得する方法について解説しました。

glob関数の使い方や、ワイルドカードの使い方、パスの指定の仕方を覚えて、ファイルの一覽を取得できるようになりましょう。
 

筆者プロフィール

平野大輝(ひらのだいき)

スキル:PHP・Java・JavaScriptを用いて様々なアプリを開発するWebエンジニア。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、PHPやフレームワークのLaravelを使ってWebアプリケーション開発を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。