dirname

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

dirnameRenvoie le chemin du dossier parent

Description

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

Renvoie le chemin parent d'un chemin représentant un fichier ou un dossier, qui correspond à levels niveau(x) plus haut que le dossier courant.

Note:

dirname() agit naïvement sur la chaine en entrée et n'est pas au courant du système de fichiers courant ou d'éventuels composants comme "..".

Attention

Sur Windows, dirname() assume que la codepage actuellement définie, donc pour qu'il puisse voir le nom de dossier correct avec des caractères multioctets dans le chemin, la codepage correspondante doit être définie. Si path contient des caractères qui sont invalides pour la codepage courante, le comportement de dirname() est indéfini.

Sur d'autres systèmes, dirname() assume que path est encodé dans un encodage compatible ASCII. Sinon le comportement de la fonction est indéfinie.

Liste de paramètres

path

Un chemin.

Sous Windows, les slash (/) et antislash (\) sont utilisés comme séparateurs de dossier. Dans les autres environnements, seul le slash (/) est utilisé.

levels

Le nombre de dossiers parents plus haut.

Doit être un entier supérieur à 0.

Valeurs de retour

Retourne le dossier parent du chemin. S'il n'y a pas de slash dans le chemin path, un point ('.') sera retourné, indiquant le dossier courant. Sinon, la chaîne retournée sera le chemin path dont on aura supprimé tous les /component.

Attention

Il faut faire attention lors de l'utilisation de cette fonction dans une boucle qui peut atteindre le dossier racine, car ceci peut produire une boucle infinie.

<?php
dirname
('.'); // Will return '.'.
dirname('/'); // Will return `\` on Windows and '/' on *nix systems.
dirname('\\'); // Will return `\` on Windows and '.' on *nix systems.
dirname('C:\\'); // Will return 'C:\' on Windows and '.' on *nix systems.
?>

Historique

Version Description
7.0.0 Ajout du paramètre optionnel levels.

Exemples

Exemple #1 Exemple avec 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);

Résultat de l'exemple ci-dessus est similaire à :

/etc
/ (ou \ sous Windows)
.
C:\
/usr

Voir aussi

  • basename() - Retourne le nom de la composante finale d'un chemin
  • pathinfo() - Retourne des informations sur un chemin système
  • realpath() - Retourne le chemin canonique absolu