preg_match
(PHP 4, PHP 5, PHP 7)
preg_match — 正規表現によるマッチングを行う
説明
preg_match
( string $pattern
, string $subject
[, array &$matches = null
[, int $flags = 0
[, int $offset = 0
]]] ) : int|false
pattern で指定した正規表現により
subject を検索します。
パラメータ
pattern検索するパターンを表す文字列。
subject入力文字列。
matchesmatchesを指定した場合、検索結果が代入されます。$matches[0]にはパターン全体にマッチしたテキストが代入され、$matches[1]には 1 番目のキャプチャ用サブパターンにマッチした 文字列が代入され、といったようになります。flagsflagsには以下のフラグの組み合わせを指定できます。PREG_OFFSET_CAPTUREこのフラグを設定した場合、各マッチに対応する文字列のオフセットも(バイト単位で)返されます。 これは、
matchesの値を配列に変更することに注意してください。 その配列のすべての要素は、 オフセット0で一致した文字列、 およびその文字列のオフセット1でのsubjectへのオフセットからなります。<?phppreg_match('/(foo)(bar)(baz)/', 'foobarbaz', $matches, PREG_OFFSET_CAPTURE);print_r($matches);?>上の例の出力は以下となります。
Array ( [0] => Array ( [0] => foobarbaz [1] => 0 ) [1] => Array ( [0] => foo [1] => 0 ) [2] => Array ( [0] => bar [1] => 3 ) [3] => Array ( [0] => baz [1] => 6 ) )PREG_UNMATCHED_AS_NULLこのフラグが渡されると、マッチしなかったサブパターンは
nullとして通知されます。 渡されなかった場合、空の string として通知されます。<?phppreg_match('/(a)(b)*(c)/', 'ac', $matches);var_dump($matches);preg_match('/(a)(b)*(c)/', 'ac', $matches, PREG_UNMATCHED_AS_NULL);var_dump($matches);?>上の例の出力は以下となります。
array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> string(0) "" [3]=> string(1) "c" } array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1) "c" }
offset通常、検索は対象文字列の先頭から開始されます。 オプションのパラメータ
offsetを使用して 検索の開始位置を (バイト単位で) 指定することも可能です。注意:
offsetを用いるのと、substr($subject, $offset)を preg_match()の対象文字列として指定するのとは 等価ではありません。 これは、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 ) )substr() 関数を利用しない別の方法として、
^アンカーではなく、 言明\GまたはA修正子を使う方法があります。 これらは両方ともoffsetパラメータとともに動作します。
返り値
preg_match() は、pattern
が指定した subject にマッチした場合に 1 を返します。
マッチしなかった場合は 0、エラーが発生した場合は false を返します。
変更履歴
| バージョン | 説明 |
|---|---|
| 7.2.0 | $flags パラメータが
|
例
例1 文字列 "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.";}?>
例2 単語 "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.";}?>
例3 URL からドメイン名を得る
<?php// get host name from URLpreg_match('@^(?:http://)?([^/]+)@i', "http://www.php.net/index.html%22, $matches);$host = $matches[1];// get last two segments of host namepreg_match('/[^.]+\.[^.]+$/', $host, $matches);echo "domain name is: {$matches[0]}\n";?>
上の例の出力は以下となります。
domain name is: php.net
例4 名前つきサブパターンの使用法
<?php$str = 'foobar: 2008';preg_match('/(?P<name>\w+): (?P<digit>\d+)/', $str, $matches);/* PHP 5.2.2 (PCRE 7.0) 以降ではこの形式でも動作しますが、 * 過去との互換性を考慮して上の形式のほうを推奨します */// preg_match('/(?<name>\w+): (?<digit>\d+)/', $str, $matches);print_r($matches);?>
上の例の出力は以下となります。
Array
(
[0] => foobar: 2008
[name] => foobar
[1] => foobar
[digit] => 2008
[2] => 2008
)
注意
ヒント ある文字列が他の文字列内に含まれているかどうかを調べるためだけに preg_match() を使うのは避けた方が良いでしょう。 strpos() 関数を使うほうが速くなります。
参考
- PCRE のパターン
- preg_quote() - 正規表現文字をクオートする
- preg_match_all() - 繰り返し正規表現検索を行う
- preg_replace() - 正規表現検索および置換を行う
- preg_split() - 正規表現で文字列を分割する
- preg_last_error() - 直近の PCRE 正規表現処理のエラーコードを返す
- preg_last_error_msg() - 最後に実行した PCRE 正規表現に関するエラーメッセージを返す
