PHP substr_compare() 関数

例

2つの文字列を比較します。

<?php
echo substr_compare("Hello world","Hello world",0);
?>

定義と使用法

substr_compare()関数は、指定された開始位置から2つの文字列を比較します。

ヒント：この関数はバイナリセーフで、オプションで大文字と小文字を区別します。

構文

<div>substr_compare(<em>string1,string2,startpos,length,case</em>)</div>

パラメータ値

パラメータ

説明

string1 Required 比較する最初の文字列を指定します

string2 Required 比較する2番目の文字列を指定します

startpos Required string1のどこから比較を開始するかを指定します。負の場合、文字列の末尾からカウントを開始します

length Optional 比較するstring1のどの部分を比較するかを指定します

case Optional 大文字と小文字を区別して比較するかどうかを指定するブール値:

FALSE - デフォルト。大文字と小文字を区別

TRUE - 大文字と小文字を区別しない

パラメータ	説明
string1	Required 比較する最初の文字列を指定します
string2	Required 比較する2番目の文字列を指定します
startpos	Required string1のどこから比較を開始するかを指定します。負の場合、文字列の末尾からカウントを開始します
length	Optional 比較するstring1のどの部分を比較するかを指定します
case	Optional 大文字と小文字を区別して比較するかどうかを指定するブール値: FALSE - デフォルト。大文字と小文字を区別 TRUE - 大文字と小文字を区別しない

Technical Details

Return Value: この関数は以下を返します:

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

<0 - string1(startposから)がstring2より小さい場合

>0 - string1(startpos から)がstring2より大きい場合

長さがstring1の長さ以上の場合、この関数はFALSEを返します。

PHP バージョン:
5+

変更ログ: PHP 5.5.11 以降 -lengthパラメータは0にすることができます。

PHP 5.1 以降では、startposに負の値を使用できるようになりました。

Return Value:	この関数は以下を返します: 0 ~ 2つの文字列が等しい場合 <0 - string1(startposから)がstring2より小さい場合 >0 - string1(startpos から)がstring2より大きい場合長さがstring1の長さ以上の場合、この関数はFALSEを返します。
PHP バージョン:	5+
変更ログ:	PHP 5.5.11 以降 -lengthパラメータは0にすることができます。 PHP 5.1 以降では、startposに負の値を使用できるようになりました。

その他の例

例

比較のためのstring1の開始位置が6番目の場合、2つの文字列を比較します。

<?php
echo substr_compare("Hello world","world",6);
?>

例

すべてのパラメータを使用:

<?php
echo substr_compare("world","or",1,2); 
echo substr_compare("world","ld",-2,2); 
echo substr_compare("world","orl",1,2); 
echo substr_compare("world","OR",1,2,TRUE); 
echo substr_compare("world","or",1,3); 
echo substr_compare("world","rl",1,2);
?>

例

異なる戻り値:

<?php
echo substr_compare("Hello world!","Hello world!",0); // the two strings are equal
echo substr_compare("Hello world!","Hello",0); // string1 is greater than string2
echo substr_compare("Hello world!","Hello world! Hello!",0); // str1 is less than str2
?>

❮ PHP 文字列リファレンス