関数・クラス解説

substr_compare

version:PHP 5, PHP 7 (公式)

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

公式リファレンス

書式

substr_compare ( string $main_str , string $str , int $offset [, int $length [, bool $case_insensitivity = FALSE ]] ) : int

説明

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

パラメータ

main_str
比較したい最初の文字列。
str
比較したい二番目の文字列。
offset
比較を開始する位置。 負の値を指定した場合は、文字列の最後から数えます。
length
比較する長さ。デフォルト値は、 main_str の長さから offset を引いたものと str の長さのうち、長いほうです。
case_insensitivity
case_insensitivity が TRUE の場合、 大文字小文字を区別せずに比較します。

返値

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

更新履歴

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

サンプル

例1 substr_compare() の例

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); // 警告

参考

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


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール