PHP マニュアル
前のページ |  | 次のページ

# preg_match_all

(PHP 3 >= 3.0.9, PHP 4, PHP 5)

preg_match_all -- 繰返し正規表現検索を行う

## 説明

int preg_match_all ( string pattern, string subject, array &matches [, int flags [, int offset]] )

`subject` を検索し、 `pattern` に指定した正規表現にマッチした すべての文字列を、`flags` で指定した 順番で、`matches` に代入します。

正規表現にマッチすると、そのマッチした文字列の後から 検索が続行されます。

## パラメータ

`pattern`

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

`subject`

  入力文字列。

`matches`

  この場合、$matches[0] は 1 回目のマッチングによるもので、 `$matches[0][0]` はパターン全体にマッチしたテキスト、 `$matches[0][1]` は第 1 のサブパターンにマッチしたテキスト、 といったようになります。同様に、`$matches[1]` は 2 回目の マッチングによるものといったようになります。

`flags`

  以下のフラグの組み合わせ (`PREG_PATTERN_ORDER` を `PREG_SET_ORDER` と組み合わせて使用することは 無意味ですので注意してください)。

  `PREG_PATTERN_ORDER`

    $matches[0] はパターン全体にマッチした文字列の配列、 $matches[1] は第 1 のキャプチャ用サブパターンにマッチした文字列の配列、 といった順番となります。

    `<?php preg_match_all("|<[^>]+>(.*)</[^>]+>|U", "<b>example: </b><div align=left>this is a test</div>", $out, PREG_PATTERN_ORDER); echo $out[0][0] . ", " . $out[0][1] . "\n"; echo $out[1][0] . ", " . $out[1][1] . "\n"; ?>`

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

        <b>example: </b>, <div align=left>this is a test</div>
        example: , this is a test

    $out[0] はパターン全体にマッチした文字列の配列を有しており、 $out[1] はタグで囲まれた文字列の配列を有しています。

  `PREG_SET_ORDER`

    $matches[0] は 1 回目のマッチングでキャプチャした値の配列、 $matches[1] は 2 回目のマッチングでキャプチャした値の配列、 といった順序となります。

    `<?php preg_match_all("|<[^>]+>(.*)</[^>]+>|U", "<b>example: </b><div align=\"left\">this is a test</div>", $out, PREG_SET_ORDER); echo $out[0][0] . ", " . $out[0][1] . "\n"; echo $out[1][0] . ", " . $out[1][1] . "\n"; ?>`

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

        <b>example: </b>, example:
        <div align="left">this is a test</div>, this is a test

  `PREG_OFFSET_CAPTURE`

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

  `flags` を指定しない場合は、 `PREG_PATTERN_ORDER` が指定されたことになります。

`offset`

  通常、検索は対象文字列の先頭から開始されます。 オプションのパラメータ `offset` を使用して 検索の開始位置を指定することも可能です。

  > 注意: `offset` を用いるのと、 `substr($subject, $offset)` を preg_match_all()の対象文字列として指定するのとは 等価ではありません。 これは、`pattern` には、 ^, $ や (?<=x) のような言明を含めることができるためです。 これに関する例については、 preg_match() を参照してください。

## 返り値

パターンがマッチした総数を返します（ゼロとなる可能性もあります）。 または、エラーが発生した場合に `FALSE` を返します。

## 変更履歴

バージョン | 説明
--- | ---
4.3.3 | パラメータ `offset` が追加されました。
4.3.0 | フラグ `PREG_OFFSET_CAPTURE` が追加されました。

## 例

例 1. テキストからすべての電話番号を得る

`<?php preg_match_all("/\(? (\d{3})? \)? (?(1) [\-\s] ) \d{3}-\d{4}/x", "Call 555-1212 or 1-800-555-1212", $phones); ?>`

例 2. HTML タグにマッチするものを見付ける（貪欲）

`<?php
// \\2 は後方参照の例。これは、pcre に正規表現中の括弧の 2 番目の
// 組、つまりこの場合は ([\w]+)、にマッチする。文字列が二重引用符で
// 括られているため、バックスラッシュの追加が必要。
$html = "<b>bold text</b><a href=howdy.html>click me</a>";
preg_match_all("/(<([\w]+)[^>]*>)(.*)(<\/\\2>)/", $html, $matches, PREG_SET_ORDER);
foreach ($matches as $val) {
echo "matched: " . $val[0] . "\n";
echo "part 1: " . $val[1] . "\n";
echo "part 2: " . $val[3] . "\n";
echo "part 3: " . $val[4] . "\n\n";
}
?>`

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

    matched: <b>bold text</b>
    part 1: <b>
    part 2: bold text
    part 3: </b>

    matched: <a href=howdy.html>click me</a>
    part 1: <a href=howdy.html>
    part 2: click me
    part 3: </a>

## 参考

preg_match()
preg_replace()
preg_split()

前のページ | ホーム | 次のページ
preg_last_error | 上に戻る | preg_match