preg_split

(PHP 3>= 3.0.9, 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 は次のフラグを組み合わせたものとする ことが可能です。(ビット和演算子|で組み合わせる):

PREG_SPLIT_NO_EMPTY

このフラグが設定されている場合、空でないもののみが、 preg_split()により返されます。

PREG_SPLIT_DELIM_CAPTURE

このフラグが設定されている場合、デリミタパターンの括弧で括ら れた式の値が取得され、同時に返されます。このフラグは4.0.5で追 加されました。

PREG_SPLIT_OFFSET_CAPTURE

このフラグが設定された場合、マッチする度に付随する文字列のオフ セットも返されます。これにより、返り値は配列となり、その各要素 はマッチした文字列を要素0subjectの中でのその文字列オフセットを要 素1とする配列となることに注意して下さい。 このフラグは、PHP 4.3.0 以降で利用可能です。

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

// " ", \r, \t, \n , \f を含むカンマまたは空白文字で句を分割します。
$keywords = preg_split ("/[\s,]+/", "hypertext language, programming");

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

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

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

$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
        )

)

注意: パラメータ flags は、PHP 4 Beta 3で追加さ れました。

spliti(), split(), implode(), preg_match(), preg_match_all(), preg_replace()も参照下さい。