(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 の場合、
大文字小文字を区別せずに比較します。
string1 が string2 より小さければ 0 より小さな値を、
string1 が string2 より大きければ 0 より大きな値を、
両者が等しければ 0 を返します。
返却される値の絶対値に、特に意味はありません。
offset が
haystack と等しい
(PHP 7.2.18, 7.3.5 より前のバージョン) か、
haystack より長い場合、
もしくは length
が設定されていて0未満である場合、
substr_compare()
は警告を表示して false を返します。
| バージョン | 説明 |
|---|---|
| 8.2.0 |
この関数は、2つの文字列の長さが等しくない場合に
strlen($string1) - strlen($string2) を返すとは限らなくなりました。
代わりに、-1 や 1 を返す可能性があります。
|
| 8.0.0 |
length は、nullable になりました。
|
| 7.2.18, 7.3.5 |
offset の値は、
haystack の長さと等しくても問題なくなりました。
|
例1 substr_compare() の例
<?php
echo substr_compare("abcde", "bc", 1, 2), PHP_EOL; // 0
echo substr_compare("abcde", "de", -2, 2), PHP_EOL; // 0
echo substr_compare("abcde", "bcg", 1, 2), PHP_EOL; // 0
echo substr_compare("abcde", "BC", 1, 2, true), PHP_EOL; // 0
echo substr_compare("abcde", "bc", 1, 3), PHP_EOL; // 1
echo substr_compare("abcde", "cd", 1, 2), PHP_EOL; // -1
echo substr_compare("abcde", "abc", 5, 1), PHP_EOL; // -1
?>When you came to this page, you may have been looking for something a little simpler: A function that can check if a small string exists within a larger string starting at a particular index. Using substr_compare() for this can leave your code messy, because you need to check that your string is long enough (to avoid the warning), manually specify the length of the short string, and like many of the string functions, perform an integer comparison to answer a true/false question.
I put together a simple function to return true if $str exists within $mainStr. If $loc is specified, the $str must begin at that index. If not, the entire $mainStr will be searched.
<?php
function contains_substr($mainStr, $str, $loc = false) {
if ($loc === false) return (strpos($mainStr, $str) !== false);
if (strlen($mainStr) < strlen($str)) return false;
if (($loc + strlen($str)) > strlen($mainStr)) return false;
return (strcmp(substr($mainStr, $loc, strlen($str)), $str) == 0);
}
?>This function efficiently implements checks for strings beginning or ending with other strings:
<?php
function str_begins($haystack, $needle) {
return 0 === substr_compare($haystack, $needle, 0, strlen($needle));
}
function str_ends($haystack, $needle) {
return 0 === substr_compare($haystack, $needle, -strlen($needle));
}
var_dump(str_begins('http://example.com', 'https://'));
?>
Note that these are not multi-byte character set aware.Take note of the `length` parameter: "The default value is the largest of the length of the str compared to the length of main_str less the offset."
This is *not* the length of str as you might (I always) expect, so if you leave it out, you'll get unexpected results. Example:
<?php
$hash = '5ドル$lalalalalalalala$crypt.output.here';
var_dump(substr_compare($hash, '5ドル$', 0)); # int(34)
var_dump(substr_compare($hash, '5ドル$', 0, 3)); # int(0)
var_dump(PHP_VERSION); # string(6) "5.3.14"
?>