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

Copy
1<?php
2
3/**
4 * basename() 関数の使用例
5 * パスからファイル名またはディレクトリ名（末尾のスラッシュがない場合）を抽出します。
6 * オプションで、指定されたサフィックス（拡張子など）を取り除きます。
7 */
8
9// 例 1: 基本的な使用方法 - ファイルパスからファイル名を抽出
10// "/path/to/file.txt" から "file.txt" を取得します。
11$path1 = "/var/www/html/index.php";
12$filename1 = basename($path1);
13echo "元のパス: '{$path1}'\n";
14echo "basename(): '{$filename1}'\n\n";
15
16// 例 2: Windows形式のパスでも動作
17// "C:\dir\file.exe" から "file.exe" を取得します。
18$path2 = "C:\\Users\\User\\Documents\\report.docx";
19$filename2 = basename($path2);
20echo "元のパス: '{$path2}'\n";
21echo "basename(): '{$filename2}'\n\n";
22
23// 例 3: オプションのサフィックス引数を使用してファイル拡張子を除去
24// "/home/user/image.jpg" から ".jpg" を取り除き "image" を取得します。
25$path3 = "/home/user/image.jpg";
26$filename3_no_ext = basename($path3, ".jpg");
27echo "元のパス: '{$path3}'\n";
28echo "basename() (サフィックス '.jpg' を除去): '{$filename3_no_ext}'\n\n";
29
30// 例 4: サフィックスがファイル名の一部と一致する場合 (末尾のみが除去される)
31// "/archive/data.tar.gz" から ".gz" を取り除き "data.tar" を取得します。
32$path4_a = "/archive/data.tar.gz";
33$filename4_no_gz = basename($path4_a, ".gz");
34echo "元のパス: '{$path4_a}'\n";
35echo "basename() (サフィックス '.gz' を除去): '{$filename4_no_gz}'\n\n";
36
37// 例 5: 複数の拡張子を持つファイルから特定のサフィックスを除去
38// "/archive/data.tar.gz" から ".tar.gz" を取り除き "data" を取得します。
39$path5 = "/archive/data.tar.gz";
40$filename5_no_tar_gz = basename($path5, ".tar.gz");
41echo "元のパス: '{$path5}'\n";
42echo "basename() (サフィックス '.tar.gz' を除去): '{$filename5_no_tar_gz}'\n\n";
43
44// 例 6: ディレクトリパスの場合 (末尾にスラッシュがある場合、空文字列を返します)
45// "/usr/local/bin/" からは空文字列が返されます。
46$path6 = "/usr/local/bin/";
47$filename6 = basename($path6);
48echo "元のパス: '{$path6}'\n";
49echo "basename(): '{$filename6}' (末尾のスラッシュは取り除かれ、空文字列が返されます)\n\n";
50
51// 例 7: ファイル名のみの場合
52// "my_script.sh" はそのまま "my_script.sh" が返されます。
53$path7 = "my_script.sh";
54$filename7 = basename($path7);
55echo "元のパス: '{$path7}'\n";
56echo "basename(): '{$filename7}'\n\n";
57
58?>

PHPのbasename()関数は、ファイルパスの文字列から末尾の要素、つまりファイル名やディレクトリ名を取得するために使用されます。

この関数は、第一引数に$pathとして処理対象のパス文字列を、第二引数にオプションとして$suffixを受け取ります。戻り値として、パスの末尾部分の文字列を返します。

第一引数に/var/www/html/index.phpのようなファイルパスを指定すると、最後のスラッシュ以降の部分であるindex.phpが返されます。この挙動はWindows形式のパス（例: C:\Users\report.docx）でも同様に機能し、report.docxを取得します。

オプションの第二引数$suffixに.jpgのような拡張子を指定すると、取得したファイル名の末尾がその文字列と一致する場合に限り、その部分が取り除かれます。例えば、パスが/home/user/image.jpgでサフィックスに.jpgを指定すると、imageという文字列が返されます。

注意点として、パスが/usr/local/bin/のようにスラッシュで終わっている場合、この関数は空の文字列を返すため、ディレクトリ名そのものを取得したい場合は事前に末尾のスラッシュを取り除く必要があります。この関数は、ファイルパスからファイル名部分だけを安全かつ手軽に抽出したい場合に非常に便利です。