トップページ 　→関数リファレンス　→テキスト処理　→PCRE　→PCRE 関数
１つ上のカテゴリへ

関数・クラス解説

preg_match_all

version:PHP 4, PHP 5, PHP 7 (公式)

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

公式リファレンス

書式

preg_match_all ( string $pattern , string $subject [, array &$matches [, int $flags = PREG_PATTERN_ORDER [, int $offset = 0 ]]] ) : int

説明

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

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

パラメータ

pattern
検索するパターンを表す文字列。
subject
入力文字列。
matches
マッチしたすべての内容を含む、 flags で指定した形式の多次元配列。
flags
以下のフラグの組み合わせ (PREG_PATTERN_ORDER を PREG_SET_ORDER と組み合わせて使用することは 無意味ですので注意してください)。
PREG_PATTERN_ORDER
$matches[0] はパターン全体にマッチした文字列の配列、 $matches[1] は第 1 のキャプチャ用サブパターンにマッチした文字列の配列、 といった順番となります。
preg_match_all("|<[^>]+>(.*)]+>|U",     "example: this is a test
",     $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] はタグで囲まれた文字列の配列を有しています。
パターンに名前付きサブパターンが含まれる場合は、$matches にはサブパターン名のキーも含まれるようになります。 サブパターンの名前が重複している場合は、いちばん右側のサブパターンだけが $matches[NAME] に格納されます。
preg_match_all(     '/(?J)(?foo)|(?bar)/',     'foo bar',     $matches,     PREG_PATTERN_ORDER ); print_r($matches['match']);
上の例の出力は以下となります。
Array( [0] => [1] => bar)
PREG_SET_ORDER
$matches[0] は 1 回目のマッチングでキャプチャした値の配列、 $matches[1] は 2 回目のマッチングでキャプチャした値の配列、 といった順序となります。
preg_match_all("|<[^>]+>(.*)]+>|U",     "example: this is a test
",     $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
このフラグを設定した場合、各マッチに対応する文字列のオフセットも(バイト単位で)返されます。 これは、matches の値を配列の配列に変更することに注意してください。 その配列のすべての要素は、 オフセット 0 で一致した文字列 およびその文字列のオフセット 1 での subject へのオフセットからなります。
preg_match_all('/(foo)(bar)(baz)/', 'foobarbaz', $matches, PREG_OFFSET_CAPTURE); print_r($matches);
上の例の出力は以下となります。
Array( [0] => Array ( [0] => Array ( [0] => foobarbaz [1] => 0 ) ) [1] => Array ( [0] => Array ( [0] => foo [1] => 0 ) ) [2] => Array ( [0] => Array ( [0] => bar [1] => 3 ) ) [3] => Array ( [0] => Array ( [0] => baz [1] => 6 ) ))
PREG_UNMATCHED_AS_NULL
このフラグが渡されると、 マッチしなかったサブパターンがあった場合 NULL として通知されます。 このフラグが渡されない場合、 空の string として通知されます。
flags を指定しない場合は、 PREG_PATTERN_ORDER が指定されたことになります。
offset
通常、検索は対象文字列の先頭から開始されます。 オプションのパラメータ offset を使用して 検索の開始位置を (バイト単位で) 指定することも可能です。
注意: offset を用いるのと、 substr($subject, $offset) を preg_match_all()の対象文字列として指定するのとは 等価ではありません。 これは、pattern には、 ^, $ や (?<=x) のような言明を含めることができるためです。 これに関する例については、 preg_match() を参照してください。

返値

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

更新履歴

バージョン 説明
7.2.0 $flags パラメータが PREG_UNMATCHED_AS_NULL をサポートしました。

サンプル

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

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

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

// \\2 は後方参照の例。これは、pcre に正規表現中の括弧の 2 番目の
// 組、つまりこの場合は ([\w]+)、にマッチする。文字列が二重引用符で
// 括られているため、バックスラッシュの追加が必要。
$html = "bold textclick me";

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[2] . "\n";
    echo "part 3: " . $val[3] . "\n";
    echo "part 4: " . $val[4] . "\n\n";
}

 
上の例の出力は以下となります。
 
matched: <b>bold text</b>
part 1: <b>
part 2: b
part 3: bold text
part 4: </b>

matched: <a href=howdy.html>click me</a>
part 1: <a href=howdy.html>
part 2: a
part 3: click me
part 4: </a>
 
例3 名前つきサブパターンの使用法
 


$str = <<\w+): (?P\d+)/', $str, $matches);

/* PHP 5.2.2 (PCRE 7.0) 以降ではこの形式でも動作しますが、
 * 過去との互換性を考慮して上の形式のほうを推奨します */
// preg_match_all('/(?\w+): (?\d+)/', $str, $matches);

print_r($matches);


 
上の例の出力は以下となります。
 
Array
(
    [0] => Array
        (
            [0] => a: 1
            [1] => b: 2
            [2] => c: 3
        )

    [name] => Array
        (
            [0] => a
            [1] => b
            [2] => c
        )

    [1] => Array
        (
            [0] => a
            [1] => b
            [2] => c
        )

    [digit] => Array
        (
            [0] => 1
            [1] => 2
            [2] => 3
        )

    [2] => Array
        (
            [0] => 1
            [1] => 2
            [2] => 3
        )

)

参考

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

    • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    ●stristr
    　大文字小文字を区別せず文字列を検索し、ヒット箇所以降（あるいは以前）の文字列を返却

    ●stripslashes
    　バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    ●stripos
    　大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    ●stripcslashes
    　addcslashes() でクォートされた文字列をアンクォートする

    ●strip_tags
    　文字列から HTML と PHP のタグを除去して返却

    ●strcspn
    　指定した文字が最初に現れる位置を調べる

    ●strcoll
    　ロケールに基づいて2つの文字列を比較し同じか（あるいは大小）を判定する

    ●strcmp
    　2つの文字列を比較し同じか（あるいは大小）を判定する

    ●strchr
    　strstr() のエイリアス

    ●strcasecmp
    　2つの文字列を比較（大文字小文字を区別せず同じとみなす）

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール