Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【PHP8.x】getBasenameメソッドの使い方

getBasenameメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getBasenameメソッドは、PHPのGlobIteratorクラスに属し、現在のイテレーションで処理されているファイルまたはディレクトリのベース名(ファイル名部分)を取得するメソッドです。GlobIteratorは、特定のパターンに一致するファイルやディレクトリを繰り返し処理するために使用されるクラスであり、このメソッドはイテレート中の各要素からファイル名のみを抽出する際に役立ちます。

このメソッドはオプションで一つの引数を取ることができます。この引数は、ファイル名から除外したい拡張子を指定するための文字列です。例えば、「document.txt」というファイル名から拡張子を除いた「document」の部分だけを取得したい場合、引数に「.txt」と指定することで、その部分が取り除かれた文字列を得ることができます。引数を省略した場合、ファイル名は拡張子を含んだ完全な形で返されます。

返り値は、指定されたパスから抽出されたベース名を表す文字列です。これにより、完全なパス情報からファイル名だけを簡単に取り出すことができ、ファイル管理や表示処理において柔軟な操作が可能となります。システムがファイルパスを扱っている際に、拡張子の有無にかかわらずファイル名を把握したい場合に特に有用な機能として利用されます。

構文(syntax)

1<?php
2
3$iterator = new GlobIterator('./*.txt');
4
5$basename = $iterator->getBasename();
6
7$basenameWithoutSuffix = $iterator->getBasename('.txt');
8
9?>

引数(parameters)

string $suffix = ''

  • string $suffix = '': 抽出したいファイル名の末尾から削除する文字列を指定します。デフォルトは空文字列で、何も削除されません。

戻り値(return)

string

GlobIterator::getBasename() メソッドは、指定されたファイルパスのベース名(拡張子を除くファイル名)を文字列として返します。