substr_compare

(PHP 5, PHP 7, PHP 8)

substr_compare指定した位置から指定した長さの 2 つの文字列について、バイナリ対応で比較する

説明

substr_compare(
    string $haystack,
    string $needle,
    int $offset,
    ?int $length = null,
    bool $case_insensitive = false
): int

substr_compare() は、haystackoffset 文字目以降の最大 length 文字を、needle と比較します。

パラメータ

haystack

比較したい最初の文字列。

needle

比較したい二番目の文字列。

offset

比較を開始する位置。 負の値を指定した場合は、文字列の最後から数えます。

length

比較する長さ。デフォルト値は、 haystack の長さから offset を引いたものと needle の長さのうち、長いほうです。

case_insensitive

case_insensitivetrue の場合、 大文字小文字を区別せずに比較します。

戻り値

haystackoffset 以降が needle より小さい場合に負の数、 needle より大きい場合に正の数、 等しい場合に 0 を返します。 offsethaystack と等しい (PHP 7.2.18, 7.3.5 より前のバージョン) か、 haystack より長い場合、 もしくは length が設定されていて0未満である場合、 substr_compare() は警告を表示して false を返します。

変更履歴

バージョン 説明
8.0.0 length は、nullable になりました。
7.2.18, 7.3.5 offset の値は、 haystack の長さと等しくても問題なくなりました。

例1 substr_compare() の例

<?php
echo substr_compare("abcde""bc"12); // 0
echo substr_compare("abcde""de", -22); // 0
echo substr_compare("abcde""bcg"12); // 0
echo substr_compare("abcde""BC"12true); // 0
echo substr_compare("abcde""bc"13); // 1
echo substr_compare("abcde""cd"12); // -1
echo substr_compare("abcde""abc"51); // 警告
?>

参考

  • strncmp() - 最初の n 文字についてバイナリセーフな文字列比較を行う

関連キーワード:  比較, バイナリ, 位置, haystack, 対応, offset, substr, 指定, compare, length