String.prototype.match()

match() メソッドは、正規表現に対する文字列 のマッチングの際に、そのマッチの結果を得るために使われます。

The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.

構文

str.match(regexp)

引数

regexp

正規表現オブジェクト (RegExp) です。RegExp ではないオブジェクト obj が渡された場合、new RegExp(obj) による RegExp オブジェクトへの暗黙的な変換が行われます。一切引数を与えずに match() メソッドを使った場合、空の文字列 1 つを持つ Array ([""]) を取得します。

返り値

グローバル (g) フラグの有無によって内容が変わる Array を返します。マッチが見つからなかった場合は null を返します。

• g フラグがある場合、キャプチャグループを除いた、正規表現にマッチしたすべての結果を返します。
• g フラグがない場合、最初のマッチとそれに対するキャプチャグループのみを返します。この場合、返される要素には下記の「追加されるプロパティ」が存在します。

追加されるプロパティ

上記で説明されたように、追加のプロパティを持つ結果が返されることがあります。

• groups: 名前付きキャプチャグループの配列です。名前付きキャプチャグループが定義されてない場合は undefined です。詳細はグループと長さを見てください。
• index: 結果が見つかった検索のインデックスです。
• input: 検索された文字列のコピーです。

詳細

正規表現が g フラグを含んでいない場合、str.match() は RegExp.exec() と同じ結果を返します。

RegExp メソッド

• 文字列が RegExp という正規表現にマッチするかどうかを知る必要がある場合、RegExp.test() を使います。
• 一番最初に見つけたマッチだけが欲しい場合、代わりに RegExp.exec() を使ったほうが良いかもしれません。
• グローバルフラグを持つ正規表現でキャプチャグループを取得する場合、RegExp.exec() を使用してください。

例

match() を使う

以下の例において、match は「Chapter」、それに続く 1 つ以上の数字、それに続く 0 回以上の小数点と数字、を見つけるために使われています。正規表現が i フラグを含む場合、大文字と小文字の違いは無視されます。

var str = 'For more information, see Chapter 3.4.5.1';
var re = /see (chapter \d+(\.\d)*)/i;
var found = str.match(re);

console.log(found);

// logs [ 'see Chapter 3.4.5.1',
//        'Chapter 3.4.5.1',
//        '.1',
//        index: 22,
//        input: 'For more information, see Chapter 3.4.5.1' ]

// 'see Chapter 3.4.5.1' is the whole match.
// 'Chapter 3.4.5.1' was captured by '(chapter \d+(\.\d)*)'.
// '.1' was the last value captured by '(\.\d)'.
// The 'index' property (22) is the zero-based index of the whole match.
// The 'input' property is the original string that was parsed.

match() で グローバル (global) フラグ と 大文字と小文字の違いを無視する (ignore case) フラグを使う

以下の例は、グローバル (global) フラグ と 大文字と小文字の違いを無視する (ignore case) フラグの使用のデモです。A から E までと、a から e までの文字のすべてが、それぞれ、配列の要素の 1 つとして返ります。

var str = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
var regexp = /[A-E]/gi;
var matches_array = str.match(regexp);

console.log(matches_array);
// ['A', 'B', 'C', 'D', 'E', 'a', 'b', 'c', 'd', 'e']

引数なしで match() を使う

var str = "Nothing will come of nothing.";

str.match();   // returns [""]

RegExp ではないオブジェクトを引数にする

引数が文字列か数値の場合、new RegExp(obj) によって RegExp に暗黙的に変換されます。それが正の符号を持った数値だった場合、RegExp() メソッドは正の符号を無視します。

var str1 = "NaN means not a number. Infinity contains -Infinity and +Infinity in JavaScript.",
    str2 = "My grandfather is 65 years old and My grandmother is 63 years old.",
    str3 = "The contract was declared null and void.";
str1.match("number");   // "number" is a string. returns ["number"]
str1.match(NaN);        // the type of NaN is the number. returns ["NaN"]
str1.match(Infinity);   // the type of Infinity is the number. returns ["Infinity"]
str1.match(+Infinity);  // returns ["Infinity"]
str1.match(-Infinity);  // returns ["-Infinity"]
str2.match(65);         // returns ["65"]
str2.match(+65);        // A number with a positive sign. returns ["65"]
str3.match(null);       // returns ["null"]

仕様

ブラウザー実装状況

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Firefox 特有のノート

• flags was a non-standard second argument only available in Firefox: str.match(regexp, flags). It has been removed starting with Firefox 49.
• Starting with Firefox 27, this method has been adjusted to conform with the ECMAScript specification. When match() is called with a global regular expression, the RegExp.lastIndex property (if specified) will be reset to 0 (バグ 501739).

関連項目

• RegExp
• RegExp.prototype.exec()
• RegExp.prototype.test()