PHPのsubstr_compare()関数の使い方を徹底解説

PHPのsubstr_compare()関数は、指定した開始位置から2つの文字列を比較するための組み込み関数です。文字列の一部分だけを抜き出して比較したい場合に便利で、大文字・小文字を区別するかどうかも指定できます。

基本構文

substr_compare(str1, str2, offset, len, case_insensitive)

パラメータの詳細

• str1 − 比較対象となる最初の文字列

• str2 − 比較対象となる2番目の文字列

• offset − 比較を開始する位置。負の値を指定した場合は、文字列の末尾から数えた位置が開始点になります。

• len − str1から比較する文字列の長さ

• case_insensitive − TRUE を指定すると、大文字と小文字を区別せずに比較します（省略可能）。

戻り値

substr_compare()関数は、比較結果に応じて以下の値を返します。

• 0 − 2つの文字列が等しい場合

• 0より小さい値 − offset以降のstr1がstr2より小さい場合

• 0より大きい値 − offset以降のstr1がstr2より大きい場合

また、len の値が str1 の長さ以上である場合、この関数は FALSE を返す点に注意が必要です。

使用例1：基本的な比較

<?php
    echo substr_compare("pqrstrs", "qr", 1, 2);
?>

出力結果

0

この例では、「pqrstrs」の1文字目（オフセット1）から2文字分「qr」を取り出し、「qr」と比較しています。両者は一致しているため、戻り値は 0 となります。

使用例2：比較する長さを変えた場合

<?php
    echo substr_compare("pqrstrs", "qr", 1, 3);
?>

出力結果

1

今度は長さを3に指定しました。オフセット1から3文字分の「qrs」と「qr」を比較すると、str1側の方が大きいため、戻り値は 1 になります。

使用例3：大文字・小文字を区別しない比較

<?php
    echo substr_compare("Laptop", "AP", 1, 2, true)."\n";
?>

出力結果

0

第5引数に true を渡すことで、大文字・小文字を無視した比較が行われます。「Laptop」の1文字目から2文字分の「ap」と「AP」は、大文字小文字を区別しなければ一致するため、戻り値は 0 です。

まとめ

substr_compare()関数を使うと、文字列全体ではなく任意の位置からの部分文字列同士を効率的に比較できます。offsetやlenを活用することで柔軟な文字列比較が可能になり、case_insensitiveパラメータを指定すれば大文字・小文字の違いを吸収した比較も簡単に実装できます。ただし、lenがstr1の長さを超えるとFALSEが返される仕様は覚えておきましょう。