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

str_word_count関数は、指定された文字列に含まれる単語の数を数えたり、単語そのものの情報を取り出したりするPHPの関数です。この関数は、文字列内のスペースや句読点などで区切られた部分を単語と認識し、その合計数を整数値で返します。

第2引数としてフォーマットを指定することで、単語の取得方法を変更できます。フォーマットを「1」に設定すると、文字列内の各単語を要素とする配列が返されます。さらに、「2」に設定すると、単語の開始位置をキー、単語自体を値とする連想配列として単語の情報を取得することが可能です。

また、第3引数では、デフォルトでは単語の一部と見なされないが、単語として扱いたい追加の文字（例えば、ハイフンやアポストロフィーなど）を指定できます。これにより、より柔軟な単語のカウントや抽出が可能になります。

この関数は、テキスト処理やデータ分析において、文字列から単語レベルの情報を効率的に取得したい場合に非常に役立ちます。単語の数を数える場合は整数値、単語の情報を配列で取得する場合は配列が戻り値として返されます。PHPでの文字列操作を学ぶ上で、この関数は非常に基本的ながら強力なツールの一つです。

str_word_count(
    string $string,
    int $format = 0,
    ?string $characters = null
): array|int

string $string, int $format = 0, ?string $characters = null

• string $string: 単語数をカウントしたい対象の文字列
• int $format = 0: 返却する形式を指定する整数。
  • 0: 単語の数を整数で返します (デフォルト)。
  • 1: 文字列の配列を返します。
  • 2: キーが単語、値がその単語の出現位置を示す連想配列を返します。
• ?string $characters = null: 単語を構成するとみなす文字を指定する文字列。指定しない場合は、ASCIIのアルファベット、数字、およびアポストロフィ (') が単語を構成するとみなされます。

array|int

この関数は、文字列中の単語数をカウントしたり、単語の配列を返します。指定されたモードによって、整数または文字列の配列が返されます。