【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 * 文字列を正規表現で分割し、指定された区切り文字も結果の配列に含めて返します。
5 *
6 * @param string $text 分割する元の文字列。
7 * @return array 分割された部分文字列と区切り文字を含む配列、またはエラー時に空の配列。
8 */
9function splitAndKeepDelimiters(string $text): array
10{
11    // 正規表現パターンを定義します。
12    // ここではカンマ(,)とセミコロン(;)を区切り文字とします。
13    // 区切り文字を丸括弧で囲むことで「キャプチャグループ」として定義します。
14    // これにより、PREG_SPLIT_DELIM_CAPTURE フラグと組み合わせて使用した際に、
15    // 分割結果の配列に区切り文字自体も含まれるようになります。
16    $pattern = '/([,;])/';
17
18    // preg_split 関数を使用して文字列を分割します。
19    // - $pattern: 上で定義した正規表現パターン。
20    // - $text: 分割する元の文字列。
21    // - -1: limit のデフォルト値。すべてのマッチを処理します。
22    // - PREG_SPLIT_DELIM_CAPTURE: パターン内のキャプチャされた区切り文字を結果に含めます。
23    // - PREG_SPLIT_NO_EMPTY: 空の要素を結果から除外します。例えば "a,,b" を分割する際に、
24    //                        真ん中の空の要素が結果に含まれないようにします。
25    $result = preg_split(
26        $pattern,
27        $text,
28        -1,
29        PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
30    );
31
32    // preg_split が false を返した場合（エラーが発生した場合）の処理。
33    if ($result === false) {
34        // エラーが発生したことを示すために空の配列を返します。
35        // 実際には、より詳細なエラーハンドリングを行うことも可能です。
36        return [];
37    }
38
39    return $result;
40}
41
42// この関数の単体動作確認例です。
43// "apple,banana;cherry" という文字列をカンマ(,)とセミコロン(;)で分割し、
44// これらの区切り文字も結果の配列に含めます。
45$inputString = "apple,banana;cherry_pie";
46$outputArray = splitAndKeepDelimiters($inputString);
47
48// 結果を表示するには、以下のコメントを解除してください。
49// print_r($outputArray);
50// 期待される出力例:
51// Array
52// (
53//     [0] => apple
54//     [1] => ,
55//     [2] => banana
56//     [3] => ;
57//     [4] => cherry_pie
58// )
59
60?>

PHPのpreg_split関数は、文字列を正規表現パターンに基づいて分割し、その結果を配列として返す関数です。このサンプルコードでは、区切り文字（デリミタ）自体も分割結果の配列に含める特徴的な利用方法を紹介しています。

splitAndKeepDelimiters関数は、与えられた文字列をカンマ(,)やセミコロン(;)で分割し、これらの区切り文字も結果の配列に含めて返します。正規表現パターン([,;])で区切り文字を丸括弧で囲むと、その部分が「キャプチャグループ」として扱われます。これにより、preg_splitの第四引数$flagsにPREG_SPLIT_DELIM_CAPTUREフラグを指定することで、キャプチャされた区切り文字が分割結果の配列に含まれるようになります。また、PREG_SPLIT_NO_EMPTYフラグは、分割によって生じる空の要素を結果から除外するために使用されます。

preg_split関数は、パターン、対象文字列、分割数の上限、フラグを引数として受け取ります。成功時は分割された部分文字列と区切り文字を含む配列を返しますが、エラーが発生した場合はfalseを返します。このサンプルコードでは、falseを返した場合に空の配列を返すことでエラーに対応しています。preg_splitは、複雑な文字列処理に非常に役立つ関数です。

Copy
1<?php
2
3/**
4 * 複数行のテキストを改行で分割するサンプルコードです。
5 * preg_split関数を使用して、さまざまな改行コードに対応し、空行を除外します。
6 */
7
8// 分割対象となる複数行の文字列を定義します。
9// ここでは、Windows(\r\n), Unix/Linux(\n), 旧Mac(\r) の異なる改行コードを含めています。
10$text = "これは最初の行です。\n";
11$text .= "これは2行目のテキストです。\r\n";
12$text .= "\n"; // 空行を含めます
13$text .= "これは4行目のテキストです。\r";
14$text .= "これは最後の行です。";
15
16// preg_split関数を使って、文字列を改行コードで分割します。
17//
18// 第1引数: '/\R/'
19//   - これは正規表現パターンです。
20//   - '\R' は、CRLF (\r\n), LF (\n), CR (\r) など、PHPが認識する
21//     あらゆる種類の改行シーケンスにマッチする便利な正規表現メタ文字です。
22// 第2引数: $text
23//   - 分割したい対象の文字列です。
24// 第3引数: -1
25//   - limit引数で、分割する要素数の最大値を指定します。-1は制限なしを意味します。
26// 第4引数: PREG_SPLIT_NO_EMPTY
27//   - flags引数で、分割の挙動を制御します。
28//   - PREG_SPLIT_NO_EMPTYフラグは、分割によって生じる空の文字列（この場合、空行）を
29//     結果の配列から除外するよう指示します。
30$lines = preg_split('/\R/', $text, -1, PREG_SPLIT_NO_EMPTY);
31
32// preg_split関数は、失敗した場合にfalseを返します。
33// 通常、パターンやサブジェクトが不正でない限り失敗することは稀ですが、
34// 念のため結果をチェックすることは良い習慣です。
35if ($lines === false) {
36    echo "文字列の分割中にエラーが発生しました。\n";
37} else {
38    echo "元のテキストが改行で分割されました。空行は除外されています。\n";
39    echo "--------------------------------------------------\n";
40    // 分割された各行をループで表示します。
41    foreach ($lines as $index => $line) {
42        echo "行 " . ($index + 1) . ": " . $line . "\n";
43    }
44    echo "--------------------------------------------------\n";
45}
46
47?>

preg_split関数は、文字列を正規表現パターンで分割し、その結果を配列として取得するためのPHP関数です。

このサンプルコードでは、preg_split関数を使用して、Windows、Unix/Linux、旧Macなど、さまざまな種類の改行コードを含む複数行のテキストを効率的に分割する方法を示しています。第一引数には正規表現パターン'/\R/'を指定しており、これはCRLF（\r\n）、LF（\n）、CR（\r）といったPHPが認識するあらゆる改行シーケンスにマッチするため、環境に依存しない分割が可能です。第二引数には分割対象となる文字列を渡します。第三引数のlimitには-1を指定し、分割する要素数に上限を設けません。さらに、第四引数にはPREG_SPLIT_NO_EMPTYフラグを指定することで、分割によって生じる空の文字列、つまり元のテキスト中の空行を結果の配列から自動的に除外します。

この関数は、成功した場合には分割された文字列の配列を返し、正規表現パターンや対象文字列に問題があった場合など、失敗した際にはfalseを返します。これにより、テキストデータから改行を除いた各行の情報を簡単に抽出し、後続の処理で利用できるようになります。

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を利用しています。その後、いくつかの文字列に対してこの関数を適用し、どのように文字列が空白で分割され、結果が配列として出力されるかを確認できます。これにより、文字列処理の一般的なタスクである空白による分割を効率的に行う方法が理解できます。