【PHP8.x】basename関数の使い方
作成日: 更新日:
basename関数は、指定されたパス文字列から、末尾のファイル名またはディレクトリ名を抽出する関数です。
この関数は、ファイルのフルパス(例: /usr/local/data/report.pdf
)が与えられたときに、そのパスの最も末尾にある名前(例: report.pdf
)だけを取り出したい場合に非常に役立ちます。パスがディレクトリの場合(例: /home/user/images/
)には、末尾のディレクトリ名(例: images
)を返します。
basename
関数は、ファイルやディレクトリの名前だけを効率的に取得できるため、ファイルの保存処理、ログファイルの解析、WebアプリケーションでのURL構築など、さまざまなパス操作の場面で利用されます。例えば、ユーザーがアップロードしたファイルのフルパスからファイル名だけを取得し、別の場所に保存するといった用途に便利です。
オプションとして、2番目の引数suffix
に文字列を指定することで、抽出した名前から特定の拡張子を取り除くことができます。例えば、basename('/path/to/document.txt', '.txt')
と実行すると、結果はdocument
となります。これにより、ファイル名と拡張子を分離する処理を簡潔に行うことが可能です。
システムエンジニアを目指す方にとって、ファイルシステムやパス操作は基本的なスキルであり、basename
関数はその理解を深め、実用的な処理を実装するための重要なツールの一つです。この関数は常に文字列を返します。
基本的な使い方
構文(syntax)
<?php
basename("/path/to/your/file.txt");
引数(parameters)
string $path, string $suffix = ""
- string $path: ファイルパスまたはディレクトリパスを指定する文字列
- string $suffix = "": 除去したい接尾辞を指定する文字列 (省略可能)
戻り値(return)
string
指定されたファイルパスから、ファイル名のみを抽出した文字列を返します。