HOWTO · JavaScript
JavaScript で名前で要素を取得
JavaScript で名前で要素を取得する方法を学びます。
このページの内容
HTML の name 属性が指定した値と一致する要素をすべて選択するには、document.getElementsByName() または CSS 属性セレクターを使った document.querySelectorAll() を使用します。前者は name 属性による検索に特化しており、後者はほかの CSS 条件も選択に加えたい場合に便利です。どちらも NodeList を返すため、先頭の項目を使う前に長さを確認し、すべての一致要素が必要な場合は反復処理します。
name 属性で要素を取得する getElementsByName()
document.getElementsByName(name) は、name 属性が指定した文字列と一致するドキュメント内の要素を検索します。一致する要素がない場合も NodeList を返します。その場合、長さは null ではなく 0 です。返されるコレクションはライブであり、ドキュメント内の一致要素が後から変更されると、その内容にも反映されます。
たとえば、次の HTML には同じ名前を持つコントロールが2つあります。コード内のラベル「Music」と「Reading」は英語のままです。
<label><input type="checkbox" name="interest" value="music" checked> Music</label>
<label><input type="checkbox" name="interest" value="reading"> Reading</label>
結果を扱う JavaScript の自己完結した例を示します。小さな document の代替オブジェクトを使っているため、ブラウザーの外でも実行できます。ページ上では、組み込みの document オブジェクトを使って同じメソッド呼び出しを行います。
const controls = [
{ name: "interest", value: "music", checked: true },
{ name: "interest", value: "reading", checked: false },
];
const document = {
getElementsByName(name) {
return controls.filter((control) => control.name === name);
},
};
const interests = document.getElementsByName("interest");
const firstInterest = interests.length > 0 ? interests[0].value : "No matches";
console.log(firstInterest);
for (const interest of interests) {
if (interest.checked) {
console.log(interest.value);
}
}
music
music
最初の値は、チェックされているかどうかにかかわらず、最初に一致したコントロールから読み取られます。ループではチェック済みの値だけを出力します。ブラウザーでは document.getElementsByName("interest") が一致する要素を返し、同じ長さの確認と反復処理を使えます。name 属性だけで選択条件が決まる場合に便利なメソッドです。
name 属性で要素を選択する querySelectorAll()
document.querySelectorAll(selectors) は CSS セレクターを受け取り、一致するすべての要素を含む静的な NodeList を返します。name 属性で要素を選ぶには、input[name="interest"] のような属性セレクターを使います。タグ条件によって対象を input 要素に限定し、属性条件で名前を照合します。必要に応じて、さらに CSS 条件を加えたり、カンマで区切った複数の条件を指定したりできます。
ブラウザーで一致する input 要素をすべて選ぶには、document.querySelectorAll('input[name="interest"]') を使い、長さを確認するかループで、返された NodeList を読み取ります。[name="interest"] だけなら、その名前を持つあらゆる要素が対象になります。ほかの種類のコントロールを除外するには、先頭に input を付けます。セレクター内の引用符は属性値を囲むものであり、値に含まれる引用符やバックスラッシュをエスケープするものではありません。任意の動的な値をそのままこのセレクターに埋め込まないでください。値からセレクターを組み立てる場合は、正しい CSS 文字列エスケープ処理を使って、CSS 文字列の文脈に合わせてエスケープします。入力由来の値を使う際に、そのような処理が手元にない場合は、セレクターを組み立てないでください。代わりに document.getElementsByName(value) を呼び出し、返された要素を JavaScript でタグやほかのプロパティに基づいて絞り込みます。
次の実行例はブラウザー DOM を使わないため、上に示した2つの input 要素を模したものです。ページ上では、組み込みの document オブジェクトを使って同じセレクター呼び出しを行います。この例のコードと表示結果に含まれるラベルやメッセージは英語のままです。例を実行してください。
const inputs = [
{ tagName: "INPUT", name: "interest", value: "music" },
{ tagName: "INPUT", name: "interest", value: "reading" },
];
const document = {
querySelectorAll(selector) {
if (selector !== 'input[name="interest"]') return [];
return inputs.filter(
(input) => input.tagName === "INPUT" && input.name === "interest",
);
},
};
const interests = document.querySelectorAll('input[name="interest"]');
if (interests.length === 0) {
console.log("No matching inputs.");
} else {
console.log(`Matches: ${interests.length}`);
for (const input of interests) {
console.log(input.value);
}
}
Matches: 2
music
reading
この例ではタグと名前の両方で2つの input 要素を選択し、その件数と値を出力します。長さを確認してから最初の要素にアクセスするため、一致する input 要素がない場合も安全です。
このメソッドは静的な NodeList を返します。セレクターに一致する要素がなければ、コレクションは空になります。セレクターは有効な CSS である必要があり、形式が不正だと SyntaxError が発生します。セレクターの詳細は、querySelectorAll() documentation を参照してください。
結果の扱い方と各メソッドの比較
どちらのメソッドも、単一の要素や null ではなくコレクションを返します。最初の要素を読む前に length を確認し、複数の一致要素を扱う場合は反復処理を使います。querySelectorAll() は静的なスナップショットを返すため、後からドキュメントが変更されてもコレクションは更新されません。getElementsByName() はライブコレクションを返し、ドキュメントの変更に応じて内容が変わることがあります。
name 属性だけで条件を指定できる場合は getElementsByName() を選びます。名前による照合を input 要素に限定する場合や、別の属性条件を加える場合など、CSS セレクターで条件を明確に表せるときは querySelectorAll() を選びます。一致する要素が1つだけ必要なら、querySelector() は最初の一致要素、または null を返します。コレクションは返しません。セレクターの構文と動作について詳しくは、querySelectorAll() documentation を参照してください。