【PHP8.x】str_contains関数の使い方

作成日: 更新日:

str_contains関数は、ある文字列の中に特定の文字列が含まれているかどうかを判定する関数です。この関数は2つの引数を受け取ります。最初の引数には、検索の対象となる元の文字列を指定します。2番目の引数には、その元の文字列の中に存在するかどうかを確認したい部分文字列を指定します。

指定された部分文字列が元の文字列内に見つかった場合、この関数は論理値のtrue(真)を返します。もし部分文字列が見つからなかった場合は、論理値のfalse(偽)を返します。

str_contains関数はPHP 8で新たに導入されました。これ以前のPHPのバージョンでは、同様の文字列の存在チェックを行うためにstrpos()関数などを使用し、その戻り値がfalseであることと、文字列の先頭で一致した場合に返される0とを区別する必要がありました。しかし、str_contains関数を使用することで、より直感的で簡潔なコードで文字列の存在をチェックできるようになり、コードの可読性が大幅に向上しました。この関数は大文字と小文字を区別して判定を行いますので、利用の際にはご注意ください。

基本的な使い方

構文(syntax)

<?php
$haystack = "Hello, world!";
$needle = "world";

// $haystackの中に$needleが含まれているかを判定します
if (str_contains($haystack, $needle)) {
    echo "'{$needle}' は '{$haystack}' の中に見つかりました。\n";
} else {
    echo "'{$needle}' は '{$haystack}' の中に見つかりませんでした。\n";
}
?>

引数(parameters)

string $haystack, string $needle

  • string $haystack: 検索対象の文字列
  • string $needle: 検索する文字列

戻り値(return)

bool

文字列 $haystack の中に、文字列 $needle が含まれているかどうかを真偽値で返します。含まれていれば true、含まれていなければ false を返します。

【PHP8.x】str_contains関数の使い方 | いっしー@Webエンジニア