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

Copy
1<?php
2
3// preg_split関数の使用例
4// この関数は、正規表現（パターン）に基づいて文字列を分割し、結果を配列として返します。
5// システムエンジニアを目指す初心者の方でも理解しやすいように、基本的な使い方を説明します。
6
7// 分割対象となる文字列を定義します。
8$subject = "apple, banana orange  grape";
9
10// --- 例1: 最も基本的な使い方 ---
11// カンマ (,) またはスペース ( ) で文字列を分割します。
12// パターン '/[, ]/' は「カンマ、またはスペース」のいずれか1文字にマッチします。
13$pattern1 = '/[, ]/';
14$result1 = preg_split($pattern1, $subject);
15
16echo "--- 例1: カンマまたはスペースで分割 ---\n";
17echo "元の文字列: \"$subject\"\n";
18print_r($result1);
19echo "\n";
20
21// --- 例2: 空の要素を除外する (PREG_SPLIT_NO_EMPTY フラグ) ---
22// 元の文字列に区切り文字が連続している場合（例: "apple,,banana" や "orange  grape"）、
23// デフォルトでは空の要素が結果の配列に含まれることがあります。
24// PREG_SPLIT_NO_EMPTY フラグを使用すると、これらの空の要素を除外できます。
25// パターン '/[, ]+/' は「1つ以上のカンマ、またはスペース」にマッチします。
26$subject2 = "apple,,banana orange  grape";
27$pattern2 = '/[, ]+/';
28$result2 = preg_split($pattern2, $subject2, -1, PREG_SPLIT_NO_EMPTY);
29
30echo "--- 例2: PREG_SPLIT_NO_EMPTY フラグで空の要素を除外 ---\n";
31echo "元の文字列: \"$subject2\"\n";
32print_r($result2);
33echo "\n";
34
35// --- 例3: 分割数を制限する (limit 引数) ---
36// limit 引数を使うと、生成される配列の要素数を最大で指定した数に制限できます。
37// 指定した数に達すると、残りの文字列は分割されず最後の要素として含まれます。
38// ここでは、最初の2つの区切り文字で分割し、最大3つの要素を生成します。
39$subject3 = "one,two,three,four,five";
40$pattern3 = '/,/';
41$limit = 3; // 生成される要素の最大数を3に設定
42$result3 = preg_split($pattern3, $subject3, $limit);
43
44echo "--- 例3: limit 引数で分割数を制限 ---\n";
45echo "元の文字列: \"$subject3\"\n";
46echo "limit = $limit\n";
47print_r($result3);
48echo "\n";
49
50?>

preg_split関数は、指定した正規表現パターンに基づいて文字列を分割し、その結果を配列として返すPHPの関数です。システムエンジニアとして、文字列データを特定の区切り文字で分解して処理する際に非常に役立ちます。

この関数は、まず第一引数に「どのような区切りで分割するか」を示す正規表現パターン $pattern を指定します。次に、第二引数 $subject に「分割したい元の文字列」を渡します。関数が成功すると、分割された各部分文字列が要素として格納された配列が返されます。もし分割に失敗した場合はfalseが返されます。

例えば、サンプルコードの例1のように、カンマまたはスペースといった複数の区切り文字で文字列を分割する際に利用できます。

さらに、オプション引数を使用することで、より細かな制御が可能です。第三引数 $limit を指定すると、生成される配列の最大要素数を制限できます。例えば、3を指定すれば、最大で3つの要素が配列に格納され、残りの文字列は分割されずに最後の要素の一部として扱われます。例3では、この$limit引数を用いて分割数を制限しています。

また、第四引数 $flags には、分割の挙動を調整するための定数を渡します。特にPREG_SPLIT_NO_EMPTYフラグはよく利用され、区切り文字が連続する場合などに発生する空の要素を結果の配列から自動的に除外することができます。例2では、このフラグを使用することで、連続するカンマやスペースによって生じる空要素が配列に含まれないようにしています。

Copy
1<?php
2
3/**
4 * 文字列を1つ以上の空白文字で分割する関数。
5 *
6 * @param string $text 分割対象の文字列
7 * @return array 分割された文字列の配列
8 */
9function splitStringByWhitespace(string $text): array
10{
11    // preg_split 関数を使用して、文字列を正規表現で指定されたパターンで分割します。
12    // /\s+/ は正規表現で、以下を意味します。
13    // \s : 任意の空白文字（スペース、タブ、改行など）にマッチします。
14    // +  : 直前の要素（ここでは \s）が1回以上繰り返されることにマッチします。
15    // このパターンにより、連続する複数の空白も1つの区切りとして扱われ、
16    // 分割結果に空の要素が含まれるのを防ぎます。
17    $parts = preg_split('/\s+/', $text);
18
19    // 分割された文字列の配列を返します。
20    return $parts;
21}
22
23// --------------------------------------------------
24// 以下は関数を実際に使用するサンプルコードです。
25// --------------------------------------------------
26
27// 分割したい文字列を定義します。
28$myString = "  Hello    World   PHP   Programming  ";
29
30// 上記の関数を呼び出して文字列を空白で分割します。
31$result = splitStringByWhitespace($myString);
32
33// 分割結果を出力して確認します。
34echo "元の文字列: '" . $myString . "'\n";
35echo "分割結果:\n";
36print_r($result);
37
38echo "\n"; // 見やすいように改行
39
40// 別の文字列で試してみます。
41$anotherString = "  Learning PHP is fun ";
42$anotherResult = splitStringByWhitespace($anotherString);
43
44echo "別の元の文字列: '" . $anotherString . "'\n";
45echo "別の分割結果:\n";
46print_r($anotherResult);
47
48?>

PHPのpreg_split関数は、指定された正規表現のパターンに基づいて文字列を分割し、その結果を配列として返す非常に便利な関数です。このサンプルコードでは、preg_split関数を使って、文字列を「1つ以上の空白文字」で分割する方法を示しています。

splitStringByWhitespace関数内で使用されているpreg_split('/\s+/', $text)という部分がその核心です。ここで/\s+/は正規表現のパターンを表します。\sは「任意の空白文字」（半角スペース、タブ、改行など）にマッチし、+は「直前の要素が1回以上繰り返される」ことを意味します。これにより、連続する複数の空白文字も1つの区切りとして扱われ、結果の配列に不要な空の要素が含まれるのを防ぐことができます。

preg_split関数の引数としては、第一引数に正規表現パターン（string $pattern）を、第二引数に分割したい対象の文字列（string $subject）を指定します。この関数の戻り値は、分割された部分文字列を格納した配列（array）となります。もし分割に失敗した場合はfalseが返されることがあります。

サンプルコードはまずsplitStringByWhitespaceという関数を定義し、その中でpreg_splitを利用しています。その後、いくつかの文字列に対してこの関数を適用し、どのように文字列が空白で分割され、結果が配列として出力されるかを確認できます。これにより、文字列処理の一般的なタスクである空白による分割を効率的に行う方法が理解できます。