【PHP8.x】dirname関数の使い方

Copy
1<?php
2
3// __DIR__ は、現在のスクリプトファイルが存在するディレクトリのフルパスを返します。
4// 例: `/var/www/html/public`
5$currentScriptDir = __DIR__;
6echo "現在のスクリプトのディレクトリ: " . $currentScriptDir . PHP_EOL;
7
8// dirname() 関数は、指定されたパスの親ディレクトリのパスを返します。
9// dirname(__DIR__) は、現在のスクリプトのディレクトリの親ディレクトリを返します。
10// 例: `/var/www/html/public` の親は `/var/www/html`
11$parentDir = dirname(__DIR__);
12echo "現在のスクリプトの親ディレクトリ: " . $parentDir . PHP_EOL;
13
14// dirname() 関数の第二引数 $levels を使用すると、指定した階層数の親ディレクトリを取得できます。
15// 例えば、2を指定すると2つ上の親ディレクトリを返します。
16// 例: `/var/www/html/public` から2つ上は `/var/www`
17$grandparentDir = dirname(__DIR__, 2);
18echo "現在のスクリプトの祖父ディレクトリ (2階層上): " . $grandparentDir . PHP_EOL;
19
20?>

PHPのdirname関数は、指定されたファイルパスやディレクトリパスの親ディレクトリのパスを取得するために使用します。

第一引数$pathには、親ディレクトリを取得したい対象のパスを文字列で指定します。第二引数$levelsはオプションで、デフォルト値は1です。この引数にnという整数を指定すると、指定されたパスからn階層上の親ディレクトリのパスを文字列として返します。

サンプルコードでは、まずPHPの特殊定数__DIR__が登場します。これは、現在のスクリプトファイルが存在するディレクトリのフルパスを自動的に返してくれるものです。例えば、/var/www/html/publicというディレクトリでスクリプトが実行されていれば、__DIR__はこのパスを返します。

dirname(__DIR__)と記述すると、現在のスクリプトの親ディレクトリ、つまり__DIR__が示すパスの一つ上のディレクトリのパスを取得できます。上記の例では、/var/www/htmlが取得されます。

さらに、dirname(__DIR__, 2)のように第二引数に2を指定すると、現在のスクリプトのディレクトリから2つ上の親ディレクトリのパスを取得できます。先の例でいえば、/var/wwwが取得されることになります。

この関数は、アプリケーション内で設定ファイルやライブラリなど、特定のリソースへのパスを現在のスクリプトの位置を基準に動的に解決したい場合に非常に役立ちます。

Copy
1<?php
2
3/**
4 * dirname() 関数は、指定されたパスの親ディレクトリのパスを返します。
5 * __FILE__ は、現在のスクリプトファイルのフルパスとファイル名を含むマジック定数です。
6 */
7
8// 1. 現在のスクリプトファイル自身のフルパスを取得します。
9// 例: /var/www/html/public/index.php
10$currentFilePath = __FILE__;
11echo "現在のファイルパス: " . $currentFilePath . "\n\n";
12
13// 2. dirname(__FILE__) を使用して、現在のスクリプトが存在するディレクトリのパスを取得します。
14// これは、現在のディレクトリの絶対パスを返します。
15// 例: /var/www/html/public
16$currentDirectory = dirname($currentFilePath);
17echo "現在のディレクトリ (dirname(__FILE__)): " . $currentDirectory . "\n";
18
19// 3. dirname() の第二引数 'levels' を使用して、指定した階層数だけ上のディレクトリを取得します。
20// dirname(__FILE__, 2) は、現在のファイルから2階層上のディレクトリのパスを返します。
21// 例: /var/www/html
22$twoLevelsUpDirectory = dirname($currentFilePath, 2);
23echo "2階層上のディレクトリ (dirname(__FILE__, 2)): " . $twoLevelsUpDirectory . "\n";
24
25// 4. PHP 5.3 以降では、__DIR__ マジック定数を使うと、
26// dirname(__FILE__) と同じく現在のスクリプトのディレクトリパスを直接取得できます。
27// 例: /var/www/html/public
28$currentDirectoryUsingDir = __DIR__;
29echo "現在のディレクトリ (__DIR__): " . $currentDirectoryUsingDir . "\n";
30
31?>

PHPのdirname()関数は、指定されたパスから親ディレクトリのパスを取得する際に利用されます。この関数は、最初の引数string $pathに処理したいパス文字列を受け取り、オプションの第二引数int $levelsで何階層上のディレクトリを取得するかを指定できます。$levelsを省略した場合、デフォルトで1階層上、つまり直接の親ディレクトリのパスがstring型で戻り値として返されます。

__FILE__は、現在のスクリプトファイル自身のフルパスとファイル名を表すPHPのマジック定数です。これとdirname()関数を組み合わせたdirname(__FILE__)は、現在のスクリプトファイルが存在するディレクトリのパスを取得する一般的な方法です。例えば、/var/www/html/public/index.phpというファイルで実行すると、結果として/var/www/html/publicというパスが得られます。

さらに、dirname(__FILE__, 2)のように第二引数に数値の2を指定すると、現在のファイルから2階層上のディレクトリのパス、例えば/var/www/htmlのような結果を取得できます。また、PHP 5.3以降では__DIR__というマジック定数を使用すると、dirname(__FILE__)と全く同じく現在のスクリプトのディレクトリパスを直接取得することが可能です。これらの機能は、設定ファイルの読み込みや、他のファイルをインクルードする際の基準パスを指定するなど、様々な場面で活用されます。