正規表現で文字列を分割する

# preg_split

(PHP 4, PHP 5, PHP 7, PHP 8)

preg_split — 正規表現で文字列を分割する

### 説明

function preg_split(
string `$pattern`,
string `$subject`,
int `$limit` = -1,
int `$flags` = 0
): array|false

指定した文字列を、正規表現で分割します。

### パラメータ

`pattern`

  検索するパターンを表す文字列。

`subject`

  入力文字列。

`limit`

  これを指定した場合、最大 `limit` 個の部分文字列を返します。 残りの文字列は、最後の部分文字列に含めて返されます。 `limit` が -1 あるいは 0 の場合は「制限が無い」ことを意味します。

`flags`

  `flags` は、次のフラグを組み合わせたものとする （ビット和演算子 `|` で組み合わせる）ことが可能です。

  `PREG_SPLIT_NO_EMPTY`
    このフラグを設定すると、空文字列でないものだけが preg_split() により返されます。
  `PREG_SPLIT_DELIM_CAPTURE`
    このフラグを設定すると、文字列分割用のパターン中の カッコによるサブパターンでキャプチャされた値も同時に返されます。
  `PREG_SPLIT_OFFSET_CAPTURE`

    このフラグを設定した場合、各マッチに対応する文字列のオフセットも返されます。 これにより、戻り値は配列の配列に変わることに注意してください。 配列のすべての要素が、オフセット `0` に、マッチした文字列、 オフセット `1` に、`subject` 内でのその文字列のオフセット からなる配列になります。

### 戻り値

`pattern` にマッチした境界で分割した `subject` の部分文字列の配列を返します。失敗した場合に `false` を返します。

### エラー / 例外

渡された正規表現のパターンがコンパイルできない場合、`E_WARNING` が発生します。

### 例

例1 preg_split() の例 : 検索文字列の諸部分を取得

    <?php
    // カンマまたは " ", \r, \t, \n , \f などの空白文字で句を分割する。
    $keywords = preg_split("/[\s,]+/", "hypertext language, programming");
    print_r($keywords);
    ?>

上の例の出力は以下となります。

    Array
    (
        [0] => hypertext
        [1] => language
        [2] => programming
    )

例2 文字列を文字要素に分割

    <?php
    $str = 'string';
    $chars = preg_split('//', $str, -1, PREG_SPLIT_NO_EMPTY);
    print_r($chars);
    ?>

上の例の出力は以下となります。

    Array
    (
        [0] => s
        [1] => t
        [2] => r
        [3] => i
        [4] => n
        [5] => g
    )

例3 文字列をマッチするものとそのオフセットに分割

    <?php
    $str = 'hypertext language programming';
    $chars = preg_split('/ /', $str, -1, PREG_SPLIT_OFFSET_CAPTURE);
    print_r($chars);
    ?>

上の例の出力は以下となります。

    Array
    (
        [0] => Array
            (
                [0] => hypertext
                [1] => 0
            )

        [1] => Array
            (
                [0] => language
                [1] => 10
            )

        [2] => Array
            (
                [0] => programming
                [1] => 19
            )

    )

### 注意

ヒント

正規表現の威力を必要としないのなら、より高速な (機能はシンプルですが) 代替関数として explode() あるいは str_split() のような選択肢があります。

ヒント

マッチングに失敗した場合は、要素が一つだけの配列を返します。その要素の内容は、入力文字列そのままになります。

### 参考

- PCRE のパターン
- preg_quote() - 正規表現文字をクオートする
- explode() - 文字列を文字列により分割する
- preg_match() - 正規表現によるマッチングを行う
- preg_match_all() - 繰り返し正規表現検索を行う
- preg_replace() - 正規表現検索および置換を行う
- preg_last_error() - 直近の PCRE 正規表現処理のエラーコードを返す

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open