dirname

(PHP 4, PHP 5, PHP 7, PHP 8)

dirnameВозвращает путь к родительскому каталогу

Описание

dirname(string $path, int $levels = 1): string

Функция получит строку, которая содержит путь к файлу или каталогу, и вернёт путь к родительскому каталогу на столько уровней выше текущего каталога, сколько указали в параметре levels.

Замечание:

Функция dirname() наивно работает со входной строкой и не знает действительную файловую систему или компоненты пути наподобие «..».

Предостережение

В ОС Windows функция dirname() принимает установленную кодовую страницу. Поэтому, чтобы функция видела правильное имя каталога, путь которого содержит многобайтовые символы, требуется устанавливать кодовую страницу, которая соответствует кодировке этих символов. Функция dirname() поведёт себя непредсказуемо, если имя пути path содержит неправильные для текущей кодовой страницы символы.

В других системах функция dirname() предполагает, что путь path закодировали в ASCII-совместимой кодировке, иначе функция ведёт себя непредсказуемо.

Список параметров

path

Путь.

На платформах Windows как разделитель имён каталогов работает и прямой /, и обратный \ слеш. В других окружениях — прямой слеш /.

levels

На сколько уровней вложенности вверх требуется пройти.

Значение должно быть целым числом больше 0.

Возвращаемые значения

Функция возвращает путь к родительской директории. Функция возвращает точку «.», которая указывает на текущую директорию, если путь path не содержит слешей, иначе возвращает путь path без последнего компонента /component.

Предостережение

При работе с функцией в цикле соблюдают осторожность, поскольку при достижении каталога верхнего уровня функция войдет в бесконечный цикл.

<?php

dirname
('.'); // Вернёт «.».
dirname('/'); // Вернёт «\» в ОС Windows и «/» в *nix-системах.
dirname('\\'); // Вернёт «\» в ОС Windows и «.» в *nix-системах.
dirname('C:\\'); // Вернёт «C:\» в ОС Windows и «.» в *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

Смотрите также

  • basename() - Возвращает конечный компонент имени пути
  • pathinfo() - Возвращает информацию о пути к файлу
  • realpath() - Возвращает канонизированный абсолютный путь к файлу

Добавить

Примечания пользователей 6 notes

up
49
y dot a dot dejong at singular dot of dot alumni dot utwente dot nl
10 years ago
As of PHP 5.3.0, you can use __DIR__ as a replacement for dirname(__FILE__)
up
36
tobylewis at mac dot com
19 years ago
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.
up
42
tapken at engter dot de
22 years ago
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');
?>
up
4
bobray at softville dot com
5 years ago
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 transformations
up
10
joe dot naylor at gmail dot com
15 years ago
The 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;
}
?>
up
3
klugg this-is-junk at tlen dot pl
19 years ago
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]: \
To Top