文字列

PHP substr関数の基本と応用について解説

2025-02-19更新日: 2025-02-19

PHPのsubstrは文字列処理でよく使われる関数です。

対象の文字列から、指定した開始位置および(必要に応じた)長さの部分だけを抽出できます。

実務では文字列の特定部分を取り出すのに便利で、効率的なコード作成に役立ちます。

目次から探す

PHP substr関数の基本機能
- 関数の目的と特徴
- 基本構文とパラメータ
利用例による実践的な操作
- シンプルな文字列抽出
- 負のインデックスを用いた例
注意点とバージョン間の差異
- エラー発生時の留意点
- PHPバージョンごとの挙動の違い
まとめ

PHP substr関数の基本機能

PHPのsubstr関数は、文字列の一部を取り出すシンプルな操作を行うために用いられます。

文字列の指定された位置から、指定した長さ分の部分文字列を抽出することができ、様々なアプリケーションに役立ちます。

単純な操作から柔軟な文字列操作まで、幅広い用途で利用されています。

関数の目的と特徴

substr関数は、指定した位置から一定の長さの文字列を取り出すために使われる関数です。

主な特徴は以下の通りです。

指定位置から部分文字列を抽出できる
長さのパラメータを指定しない場合、開始位置以降の全ての文字を返す
負の数値を用いることで、文字列の末尾からの抽出も可能

シンプルな操作性と柔軟なパラメータ設定が、さまざまなシナリオで利用される理由となっています。

基本構文とパラメータ

substr関数の基本構文は以下のようになります。

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

関数は、対象となる文字列$stringと、抽出開始位置$start、さらに抽出する文字数を指定する$lengthの3つのパラメータを取ります。

各パラメータの役割について、以下で詳しく説明します。

開始位置の指定方法

抽出開始位置$startは、文字列内のどの位置から抽出を開始するかを指定するために用いられます。

正の整数を指定した場合、文字列の先頭(先頭はインデックス0)から数えた位置から抽出が始まります。

負の整数を指定すると、文字列の末尾からのオフセットとなり、末尾から数えて指定した位置が開始位置となります。

例として、文字列"Hello World"から"World"を抽出する場合、おおむね以下のように記述します。

<?php
  $string = "Hello World";
  // インデックス6(空白を含む)から5文字を抽出
  $result = substr($string, 6, 5);
  echo $result; // 出力: World
?>

World

抽出文字数の設定方法

抽出する文字数は$lengthパラメータで指定します。

正の整数を用いると、その数だけ文字を抽出します。

もし$lengthが省略された場合、開始位置から文字列の最後まですべて抽出されます。

また、$lengthに負の整数を指定すると、文字列の末尾から指定した分だけ除いた部分が抽出されるため、柔軟な抽出が可能です。

以下のサンプルコードでは、全体の文字列から一定の範囲を抽出する例を示しています。

<?php
  $string = "PHP substr function";
  // 文字列冒頭から7文字を抽出
  $result = substr($string, 0, 7);
  echo $result; // 出力: PHP str
?>

PHP str

利用例による実践的な操作

実際のコード例を通して、substr関数の操作方法について具体的な使い方を紹介します。

基本的な例から特殊な用途まで、手順に沿って順番に確認してください。

シンプルな文字列抽出

シンプルな例として、単一バイト文字および複数バイト文字を対象に部分文字列を抽出する方法を見ていきます。

単一バイト文字での使用例

アルファベットなど、単一バイトの文字列に対しては、通常のsubstr関数で正確な抽出が可能です。

以下の例では、文字列"Hello World"から"World"を取り出す手順を示しています。

<?php
  $string = "Hello World";
  // インデックス6から5文字を抽出して出力
  $output = substr($string, 6, 5);
  echo $output; // 結果: World
?>

World

複数バイト文字での対応

日本語などの複数バイト文字の場合、substr関数は文字単位ではなくバイト単位で動作するため、文字化けや途中で切れる可能性があります。

複数バイト文字を正しく扱う場合は、mb_substrの使用が推奨されますが、ここではsubstrによる注意点も理解するために例を示します。

<?php
  $string = "こんにちは世界";
  // バイト数で指定するため、意図しない文字列の切れ方になる場合があります
  $output = substr($string, 3, 6);
  echo $output; // 出力結果は期待と異なる可能性がある
?>

(出力結果は環境により異なります)

負のインデックスを用いた例

負のインデックスを使用することで、文字列の末尾から抽出を行うことができます。

これにより、文字列の終わりの部分を簡単に取得できるようになっています。

予期しない結果の回避方法

負のインデックスを使う際、抽出範囲や文字数との組み合わせによっては、意図しない結果が返される場合があります。

特に複数バイト文字の場合は、正しく抽出できないことがあるため注意が必要です。

以下のコードは、単一バイト文字列における負のインデックス使用例を示しています。

<?php
  $string = "abcdef";
  // 負のインデックス-3を指定すると、末尾から3番目から抽出し、結果は"def"となる
  $result = substr($string, -3);
  echo $result; // 結果: def
?>

def

注意点とバージョン間の差異

substr関数を使用する際には、いくつかの注意点が存在します。

また、PHPのバージョンによっては動作の微妙な違いがあるため、開発環境に合わせた適切な対処が必要です。

エラー発生時の留意点

パラメータに不正な値を指定した場合、substr関数はエラーや思わぬ結果を返すことがあります。

特に、開始位置が文字列の長さを超えている場合や、$lengthの値が不適切な場合は、空文字が返されることがあります。

不正な引数の扱い

以下のサンプルコードは、開始位置が文字列の長さより大きい場合の動作を示しています。

この場合、空文字が返されるため、結果に注意が必要です。

<?php
  $string = "Sample";
  // 開始位置10は、文字列長7を超えるため、空の文字列が返る
  $result = substr($string, 10);
  echo $result; // 結果: (何も表示されない)
?>

(空の出力)

PHPバージョンごとの挙動の違い

PHPのバージョンにより、substr関数の動作に細かな違いが存在する場合があります。

特に、負の値や不正なパラメータの扱いに関しては、特定のバージョンで動作が変更される可能性があります。

バージョンアップ時の変更点

PHPの新しいバージョンでは、過去のバージョンで発生していた予期しない動作が改善されるケースがあります。

例えば、$lengthパラメータに負の値を指定した場合、結果として返される部分文字列の範囲が明確に定義されるようになりました。

以下の例は、負の$lengthを指定した場合の使用例を示しています。

<?php
  $string = "Example";
  // lengthパラメータに-3を指定することで、末尾3文字を除いた部分文字列を取得
  $result = substr($string, 0, -3);
  echo $result; // 結果: Exam
?>

Exam

まとめ

この記事を通して、PHPのsubstr関数の基本機能と実践的な操作、エラー処理やバージョンごとの違いについて詳しく学びました。

全体を通して、文字列操作の具体的な手順と注意点が明確になり、コードの実装方法が把握できたと総括できます。

ぜひ、実際にコードを実行して、理解を深めてみてください。