dirname
(PHP 4, PHP 5, PHP 7, PHP 8)
dirname — 親ディレクトリのパスを返す
説明
ファイルあるいはディレクトリへのパスを含む文字列を受け取って、
カレントディレクトリから levels レベルさかのぼった親ディレクトリのパスを返します。
注意:
dirname() は、入力文字列を単純にそのまま処理します。 実際のファイルシステムを確認したり "
.." のようなパスを気にしたりすることはありません。
Windows では、dirname()
は現在設定されているコードページに依存します。
よって、マルチバイト文字が含まれたパスを正しく表示するには、
それと一致するコードページが設定されていなければいけません。
現在のコードページから見て不正な文字が path に含まれていた場合、
basename() の動作は未定義です。
Windows 以外のシステムでは、
path はASCII と互換性があるエンコーディングでエンコードされていると想定されています。
そうでない場合、この関数の動作は未定義です。
パラメータ
path-
パス。
Windows では、スラッシュ(
/)とバックスラッシュ (\)の両方がディレクトリ区切り文字として使われます。 その他の環境ではスラッシュ(/)になります。 levels-
親ディレクトリをどこまでさかのぼるか。
正の整数でなければいけません。
戻り値
親ディレクトリのパスを返します。
path にスラッシュが無い場合は、
カレントディレクトリを示すドット ('.')
を返します。それ以外の場合は、スラッシュ以降の
/component 部分を取り除いた
path を返します。
この関数をトップレベルディレクトリまで走査するループで使う場合は、 注意が必要です。なぜなら、無限ループに陥る可能性があるからです。
<?php
dirname('.'); // '.' を返します。
dirname('/'); // Windows では `\` を、*nix システムでは '/' を返します。
dirname('\\'); // Windows では `\` を、*nix システムでは '.' を返します。
dirname('C:\\'); // Windows では 'C:\' を、*nix システムでは '.' を返します。
?>変更履歴
| バージョン | 説明 |
|---|---|
| 7.0.0 |
オプションのパラメータ levels が追加されました。
|
例
例1 dirname() の例
<?php
echo dirname("/etc/passwd") . PHP_EOL;
echo dirname("/etc/") . PHP_EOL;
echo dirname(".") . PHP_EOL;
echo dirname("C:\\") . PHP_EOL;
echo dirname("/usr/local/lib", 2);
?>上の例の出力は、 たとえば以下のようになります。
/etc / (Windows の場合は \) . C:\ /usr
User Contributed Notes 6 notes
As of PHP 5.3.0, you can use __DIR__ as a replacement for dirname(__FILE__)Since the paths in the examples given only have two parts (e.g. "/etc/passwd") it is not obvious whether dirname returns the single path element of the parent directory or whether it returns the whole path up to and including the parent directory. From experimentation it appears to be the latter.
e.g.
dirname('/usr/local/magic/bin');
returns '/usr/local/magic' and not just 'magic'
Also it is not immediately obvious that dirname effectively returns the parent directory of the last item of the path regardless of whether the last item is a directory or a file. (i.e. one might think that if the path given was a directory then dirname would return the entire original path since that is a directory name.)
Further the presense of a directory separator at the end of the path does not necessarily indicate that last item of the path is a directory, and so
dirname('/usr/local/magic/bin/'); #note final '/'
would return the same result as in my example above.
In short this seems to be more of a string manipulation function that strips off the last non-null file or directory element off of a path string.To get the directory of current included file:
<?php
dirname(__FILE__);
?>
For example, if a script called 'database.init.php' which is included from anywhere on the filesystem wants to include the script 'database.class.php', which lays in the same directory, you can use:
<?php
include_once(dirname(__FILE__) . '/database.class.php');
?>Be aware that if you call dirname(__FILE__) on Windows, you may get backslashes. If you then try to use str_replace() or preg_replace() to replace part of the path using forward slashes in your search pattern, there will be no match. You can normalize paths with $path = str_replace('\\', '/' ,$path) before doing any transformationsThe dirname function does not usually return a slash on the end, which might encourage you to create links using code like this:
$url = dirname($_SERVER['PHP_SELF']) . '/somepage.php';
However dirname returns a slash if the path you specify is the root, so $url in that case would become '//somepage.php'. If you put that URL as the action on a form, for example, submitting the form will try to go to http://somepage.php.
I ran into this when I wrote a site on a url with a path, www.somehost.com/client/somepage.php, where the code above works great, but then wanted to put it on a subdomain, client.somehost.com/somepage.php, where things started breaking.
The best solution would be to create a function that generates absolute URLs and use that throughout the site, but creating a safe_dirname function (and an htaccess rewrite to fix double-slashes just in case) fixed the issue for me:
<?php
function safe_dirname($path)
{
$dirname = dirname($path);
return $dirname == '/' ? '' : $dirname;
}
?>Attention with this. Dirname likes to mess with the slashes.
On Windows, Apache:
<?php
echo '$_SERVER[PHP_SELF]: ' . $_SERVER['PHP_SELF'] . '<br />';
echo 'Dirname($_SERVER[PHP_SELF]: ' . dirname($_SERVER['PHP_SELF']) . '<br>';
?>
prints out
$_SERVER[PHP_SELF]: /index.php
Dirname($_SERVER[PHP_SELF]: \