Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】PATHINFO_ALL定数の使い方

PATHINFO_ALL定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

PATHINFO_ALL定数は、ファイルパスに関するすべての情報を取得することを指定する定数です。この定数は、PHPの標準関数であるpathinfo()関数の第2引数に指定して使用します。pathinfo()関数は、指定されたファイルパスから、ディレクトリ名(dirname)、ファイル名(basename)、ファイルの拡張子(extension)、そして拡張子を除いたファイル名であるベース名(filename)といった情報を一度に抽出します。

PATHINFO_ALL定数を指定することで、これらの情報を個別に取得するための定数(PATHINFO_DIRNAME, PATHINFO_BASENAME, PATHINFO_EXTENSION, PATHINFO_FILENAME)をそれぞれ指定する手間が省け、簡潔にパスの全要素を把握できます。例えば、「/var/www/html/index.php」というファイルパスに対してPATHINFO_ALL定数を用いてpathinfo()関数を実行すると、dirnameには「/var/www/html」、basenameには「index.php」、extensionには「php」、filenameには「index」という値が、連想配列として返されます。

この機能は、ファイルの構成要素を詳細に分析したい場合や、ファイル操作を行うアプリケーション開発において非常に役立ちます。システムのファイル管理、ウェブアプリケーションにおけるURL解析、あるいは特定のファイル形式の判別など、多岐にわたるシーンでこの定数が活用され、効率的なプログラミングを支援します。

構文(syntax)

1<?php
2$path_parts = pathinfo('/path/to/file.ext', PATHINFO_ALL);
3?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

PATHINFO_ALL は、pathinfo() 関数でファイルパスの全情報を連想配列として取得するための定数です。この定数を指定すると、ファイル名、拡張子、ディレクトリ名、ベース名などをまとめて取得できます。

関連コンテンツ