preg_matchとは何？わかりやすく解説 Weblio辞書

preg_match

(PHP 4, PHP 5)
preg_match — 正規表現によるマッチングを行う

説明

int preg_match ( string pattern, string subject [, array &matches [, int flags [, int offset]]] )
pattern で指定した正規表現により subject を検索します。

パラメータ

pattern

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

subject

入力文字列。

matches

matches を指定した場合、検索結果が代入されます。 $matches[0] にはパターン全体にマッチしたテキストが代入され、 $matches[1] には 1 番目ののキャプチャ用サブパターンにマッチした文字列が代入され、といったようになります。

flags

flags には以下のフラグを指定できます。

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

offset

通常、検索は対象文字列の先頭から開始されます。オプションのパラメータ offset を使用して検索の開始位置を指定することも可能です。
注意: offset を用いるのと、 substr($subject, $offset) を preg_match_all()の対象文字列として指定するのとは等価ではありません。これは、pattern には、 ^, $ や (?<=x) のような言明を含めることができるためです。以下を比べてみてください。

 <?php
 $subject = "abcdef";
 $pattern = '/^def/';
 preg_match($pattern, $subject, $matches, PREG_OFFSET_CAPTURE, 3);
 print_r($matches);
 ?>

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


Array
(
)

一方、この例を見てください。

 <?php
 $subject = "abcdef";
 $pattern = '/^def/';
 preg_match($pattern, substr($subject,3), $matches, PREG_OFFSET_CAPTURE);
 print_r($matches);
 ?>

出力は以下のようになります。


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

)

返り値

preg_match() は、pattern がマッチした回数を返します。つまり、0 回（マッチせず）または 1 回となります。これは、最初にマッチした時点でpreg_match() は検索を止めるためです。逆にpreg_match_all()は、 subject の終わりまで検索を続けます。 preg_match() は、エラーが発生した場合にFALSEを返します。

変更履歴

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

例

例 1613. 文字列 "php" を探す

 <?php
 // パターンのデリミタの後の "i" は、大小文字を区別しない検索を示す
 if (preg_match("/php/i", "PHP is the web scripting language of choice.")) {
    echo "A match was found.";
 } else {
    echo "A match was not found.";
 }
 ?>

例 1614. 単語 "web" を探す

 <?php
 /* パターン内の \b は単語の境界を示す。このため、独立した単語の
  *  "web"にのみマッチし、"webbing" や "cobweb" のような単語の一部にはマッチしない */
 if (preg_match("/\bweb\b/i", "PHP is the web scripting language of choice.")) {
    echo "A match was found.";
 } else {
    echo "A match was not found.";
 }
 
 if (preg_match("/\bweb\b/i", "PHP is the website scripting language of choice.")) {
    echo "A match was found.";
 } else {
    echo "A match was not found.";
 }
 ?>

例 1615. URL からドメイン名を得る

 <?php
 // get host name from URL
 preg_match('@^(?:http://)?([^/]+)@i',
    "http://www.php.net/index.html", $matches);
 $host = $matches[1];
 
 // get last two segments of host name
 preg_match('/[^.]+\.[^.]+$/', $host, $matches);
 echo "domain name is: {$matches[0]}\n";
 ?>

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