preg_split
(PHP 4, PHP 5)
preg_split — 正規表現で文字列を分割する
説明
array preg_split
( string $pattern
, string $subject
[, int $limit
[, int $flags
]] )
指定した文字列を、正規表現で分割します。
パラメータ
- pattern
-
検索するパターンを表す文字列。
- subject
-
入力文字列。
- limit
-
これを指定した場合、最大 limit 個の部分文字列が返されます。そして、 limit が -1 の場合は「制限が無い」ことを意味します。 これは、flags を指定する場合に有用です。
- flags
-
flags は、次のフラグを組み合わせたものとする （ビット和演算子｜で組み合わせる）ことが可能です。
- PREG_SPLIT_NO_EMPTY
- このフラグを設定すると、空文字列でないものだけが preg_split() により返されます。
- PREG_SPLIT_DELIM_CAPTURE
- このフラグを設定すると、文字列分割用のパターン中の カッコによるサブパターンでキャプチャされた値も同時に返されます。
- PREG_SPLIT_OFFSET_CAPTURE
-
このフラグを設定した場合、各マッチに対応する文字列のオフセットも返されます。 これにより、返り値は配列となり、配列の要素 0 はマッチした文字列、 要素 1 は subject におけるマッチした文字列のオフセット値となることに 注意してください。
返り値
pattern にマッチした境界で分割した subject の部分文字列の配列を返します。
変更履歴
| バージョン | 説明 |
|---|---|
| 4.3.0 | PREG_SPLIT_OFFSET_CAPTURE が追加されました。 |
| 4.0.5 | PREG_SPLIT_DELIM_CAPTURE が追加されました。 |
| 4.0.0 | パラメータ flags が追加されました。 |
例
Example#1 preg_split() の例 : 検索文字列のある部分を取得
<?php
// カンマまたは " ", \r, \t, \n , \f などの空白文字で句を分割する。