(PHP 5, PHP 7, PHP 8)
substr_compare — 指定した位置から指定した長さの 2 つの文字列について、バイナリ対応で比較する
$haystack,$needle,$offset,$length = null,$case_insensitive = false
substr_compare() は、haystack
の offset 文字目以降の最大
length 文字を、needle
と比較します。
haystack比較したい最初の文字列。
needle比較したい二番目の文字列。
offset比較を開始する位置。 負の値を指定した場合は、文字列の最後から数えます。
length
比較する長さ。デフォルト値は、
haystack の長さから offset を引いたものと
needle の長さのうち、長いほうです。
case_insensitive
case_insensitive が true の場合、
大文字小文字を区別せずに比較します。
haystack の offset
以降が needle より小さい場合に負の数、
needle より大きい場合に正の数、
等しい場合に 0 を返します。
offset が
haystack と等しい
(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", 1, 2); // 0
echo substr_compare("abcde", "de", -2, 2); // 0
echo substr_compare("abcde", "bcg", 1, 2); // 0
echo substr_compare("abcde", "BC", 1, 2, true); // 0
echo substr_compare("abcde", "bc", 1, 3); // 1
echo substr_compare("abcde", "cd", 1, 2); // -1
echo substr_compare("abcde", "abc", 5, 1); // 警告
?>