PHPのstrspn()関数とは？構文・パラメータ・使い方をわかりやすく解説

はじめに

PHPのstrspn()関数は、文字列の先頭から見て、charlistパラメータに含まれる文字が連続して現れる長さ（文字数）を返す関数です。charlistに含まれない文字が出現した時点で処理が終了し、それまでに一致した文字数が結果として返されます。

構文

strspn(str, charlist, begin, len)

パラメータ

• str − 検索対象となる文字列

• charlist − 検索対象とみなす（許可する）文字の一覧

• begin − 検索を開始する位置（省略可能）。負の値を指定すると文字列の末尾からの位置になります

• len − 検索する長さ（省略可能）。負の値を指定すると末尾から指定文字数分除外されます

戻り値

strspn()関数は、charlistパラメータに含まれる文字が文字列の先頭から連続して見つかった数を返します。先頭の文字がcharlistに含まれていない場合は 0 を返します。

使用例

以下は、strspn()関数を使用した例です。

<?php
   echo strspn("mobilephone", "o");
?>

出力

0

この例では、文字列「mobilephone」の先頭が「m」であり、charlistに指定した「o」と一致しないため、結果は「0」となります。

複数の文字を指定した場合の例

charlistには複数の文字をまとめて指定できます。

<?php
   echo strspn("mobilephone", "mbo");
?>

この場合、先頭から「m」「o」「b」と順にcharlistに含まれているため、次の「i」の時点で判定が止まり、出力は「3」になります。

まとめ

strspn()関数は、文字列の先頭部分が指定した文字だけで構成されているかを確認したい場合に便利な関数です。入力値の妥当性チェックなどにも活用できます。