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

作成日: 更新日:

substr関数は、文字列の一部分を抽出する関数です。文字列の中から指定した開始位置から指定した文字数分の文字列を取り出し、新しい文字列として返します。この関数は、元の文字列を変更することなく、部分文字列を取得するために使用されます。

substr関数は、3つの引数を受け取ります。最初の引数は、操作対象となる文字列です。2番目の引数は、部分文字列の開始位置を示す整数値です。開始位置は0から始まり、文字列の先頭が0番目となります。3番目の引数は、抽出する文字数を示す整数値です。この引数を省略した場合、開始位置から文字列の末尾までのすべての文字が抽出されます。

開始位置に負の値を指定した場合、文字列の末尾からのオフセットとして解釈されます。例えば、-1を指定すると、文字列の最後の文字から開始されます。文字数に負の値を指定した場合、文字列の末尾から指定された文字数だけ手前までが抽出されます。

substr関数は、文字列処理において非常に汎用的な関数であり、文字列の解析、データの抽出、フォーマット変換など、さまざまな場面で利用されます。例えば、長い文字列から特定の情報を抜き出したり、ファイル名から拡張子を取り除いたりする際に役立ちます。文字列操作を行う際には、substr関数の機能を理解しておくことが重要です。

基本的な使い方

構文(syntax)

substr ( string $string , int $offset , ?int $length = null ) : string

引数(parameters)

string $string, int $offset, ?int $length = null

  • string $string: 部分文字列を抽出したい元の文字列
  • int $offset: 部分文字列の抽出を開始する位置(インデックス)。0から始まります。負の値を指定すると、文字列の末尾から数えて指定した位置から抽出を開始します。
  • ?int $length = null: 抽出する部分文字列の長さ。省略した場合(null)、または負の値を指定した場合は、$offset から文字列の末尾までの部分文字列が抽出されます。

戻り値(return)

string

指定された位置から指定された長さの文字列を切り出して返します。

【PHP8.x】substr関数の使い方 | いっしー@Webエンジニア