RegExp.prototype.exec()

exec() メソッドは、指定された文字列内で一致するものの検索を実行します。結果の配列、または null を返します。

global または sticky フラグを持つ RegExp オブジェクト（例： /foo/g、/foo/y ）はステートフルです。以前のマッチから lastIndex を保持します。String.prototype.match() と異なり、exec() は lastIndex を内部的に使うことによって、反復することでテキストの文字列にある複数の一致をキャプチャグループとともに取得できます。

文字列の（キャプチャグループを含んだ）複数の一致を簡単に取得できる新しい関数 String.prototype.matchAll() が提案されています。

単に見つかったか見つからなかったかを知るために一致を実行するのであれば、 RegExp.prototype.test() メソッド又は String.prototype.search() メソッドを使用してください。

この対話型サンプルのソースファイルは GitHub リポジトリに格納されています。対話型サンプルプロジェクトに協力したい場合は、 https://github.com/mdn/interactive-examples をクローンしてプルリクエストを送信してください。

構文

regexObj.exec(str)

引数

str

正規表現に一致するかどうかの対象となる文字列です。

返値

一致に成功した場合、 exec() メソッドは（ index ・ input の拡張プロパティを含んだ）配列を返し、正規表現オブジェクトの lastIndex プロパティを更新します。返値の配列には最初の項目として一致した文字列が入り、一致した文字列の中に含まれるそれぞれの括弧が1つずつ項目として入ります。

一致に失敗した場合は、exec() メソッドは null を返し、lastIndex を 0 にします。

説明

次の例を考えてください。

// "quick brown" の後に "jumps" が来るものを、その間の文字を無視して一致させます。
// "brown" と "jumps" を取得します。
// 大文字と小文字は区別しません。
var re = /quick\s(brown).+?(jumps)/ig;
var result = re.exec('The Quick Brown Fox Jumps Over The Lazy Dog');

このスクリプトの結果は以下の表の通りです。

例

連続して行う一致の検索

正規表現で "g" フラグを使用する場合、同じ文字列で連続して一致を見つけるために exec() メソッドを複数回使うことができます。その際、検索は正規表現オブジェクトの lastIndex プロパティで指定された位置の str の部分文字列から始まります (test() も lastIndex プロパティの位置を進めます)。なお、別の文字列を検索する場合でも lastIndex プロパティはリセットされず、既存の lastIndex から検索を始めます。

例えば、次のスクリプトを考えてみてください。

var myRe = /ab*/g;
var str = 'abbcdefabh';
var myArray;
while ((myArray = myRe.exec(str)) !== null) {
  var msg = myArray[0] + ' を見つけました。';
  msg += '次の検索は ' + myRe.lastIndex + ' からです。';
  console.log(msg);
}

このスクリプトは以下のテキストを表示します。

abb を見つけました。次の検索は 3 からです。
ab を見つけました。次の検索は 9 からです。

RegExp リテラルでの exec() の使用

明示的に RegExp オブジェクトを作成せずに exec() を使用することもできます。

var matches = /(hello \S+)/.exec('This is a hello world!');
console.log(matches[1]);

これは 'hello world!' というメッセージをログ出力します。

仕様書

ブラウザーの対応

関連項目

• JavaScript ガイド の正規表現の章
• RegExp