定義と使い方
getElementsByTagName()関数は、指定した要素のタグ名に該当するすべての要素を探し、HTMLCollectionオブジェクトとして返します。一致する要素がない場合は、空のHTMLCollectionオブジェクトを返します。
返されるHTMLCollectionオブジェクトに含まれる各要素を順番に処理して、特定の処理を実行できます。
HTMLCollection- WebページのHTML文書内で選択された要素だけを、文書内の順序に従ってまとめた集合です。一般にDOMコレクションと呼ばれるこの集合は、要素を配列の要素と同様に扱うことができ、Webページの要素を簡単に操作できるようにするオブジェクトです。
覚えておいてください!HTMLCollectionは配列に似たオブジェクトであり、for...of文で反復処理できるオブジェクトです。また、DOMの変更をリアルタイム(またはlive)で反映するオブジェクトです。lengthプロパティを使用すると、配列に似たオブジェクトであるHTMLCollectionの長さを取得できます。
基本例
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<title>getElementsByTagName()</title>
</head>
<body>
<ul>
<li>おにぎり</li>
<li>ラーメン</li>
<li>うどん</li>
</ul>
<script src="tag-name.js"></script>
</body>
</html>
const liElements = document.getElementsByTagName("li"); // liタグをすべて取得
console.log(liElements); // HTMLCollection(3) [li, li, li]
/* 方法1 - for...of文を使用 */
for (const liElement of liElements) {
console.log(liElement.textContent);
}
// 出力: "おにぎり" "ラーメン" "うどん"
/* 方法2 - for文を使用 */
for (let i = 0; i < liElements.length; i++) { // lengthプロパティを使用できます
console.log(liElements[i].textContent);
}
// 出力: "おにぎり" "ラーメン" "うどん"
/* 方法3_1 - forEach()関数を使用 */
const arr = [...liElements]; // スプレッド構文で配列を作成
arr.forEach(li => {
console.log(li.textContent);
});
// 出力: "おにぎり" "ラーメン" "うどん"
/* 方法3_2 - forEach()関数を使用 */
const liElementsArray = Array.from(liElements); // Array.from()メソッドで配列を作成
liElementsArray.forEach(li => {
console.log(li.textContent);
});
// 出力: "おにぎり" "ラーメン" "うどん"
getElementsByTagName()関数が返すHTMLCollectionは配列ではないため、forEach()関数を直接使用することはできません。HTMLCollectionは配列と似た配列風オブジェクトですが、実際の配列ではないため、配列のメソッドをサポートしていません。ただし、Array.from()またはスプレッド(...)構文を使用して配列に変換すれば、forEach()を使用できます。
コードの補足説明forEach()関数は、配列を反復処理し、各要素をコールバック関数で処理するための関数です。
コードの補足説明for文は、指定した回数や範囲で処理を繰り返すための文です。配列に似たオブジェクトを走査できます。
コードの補足説明textContentプロパティは、HTML要素のテキストコンテンツを取得または設定します。
構文
// HTML文書全体から
document.getElementsByTagName(name)
// 特定の要素内から
element.getElementsByTagName(name)
引数
name |
探したい要素のタグ名に該当するすべての要素です。この値は大文字と小文字を区別しない文字列です。 特殊文字 "*"は、すべての要素を表します。 |
|---|
戻り値
- HTML文書内で、指定した要素のタグ名に該当するすべての要素を
HTMLCollectionオブジェクトとして返します。 - 一致する要素がない場合は、空の
HTMLCollectionオブジェクトを返します。
返り値の例
引数の値が特殊文字"*"の場合
引数の値が特殊文字"*"の場合は、すべての要素を返します。
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<title>getElementsByTagName("*")</title>
</head>
<body>
<h1>getElementsByTagName("*")</h1>
<ul>
<li>おにぎり</li>
<li>ラーメン</li>
<li>うどん</li>
</ul>
<script>
const allElements = document.getElementsByTagName("*");
console.log(allElements);
// HTMLCollection(11) [html, head, meta, title, body, h1, ul, li, li, li, script]
</script>
</body>
</html>
一致する要素のn番目の要素を扱う場合
一致する要素のn番目の要素を扱うには、次のようにします。
getElementsByTagName(name)[n]
getElementsByTagName()メソッドは、配列風オブジェクトであるHTMLCollectionを返します。配列と同様に、インデックスを使って要素にアクセスできます。
次は、HTML文書内の<li>タグの最初の要素を扱う例です。
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<title>getElementsByTagName()[n]</title>
</head>
<body>
<h1>getElementsByTagName()[n]</h1>
<ul>
<li>おにぎり</li>
<li>ラーメン</li>
<li>うどん</li>
</ul>
<script>
const liElements = document.getElementsByTagName("li"); // liタグをすべて取得
/* HTML文書内の <li>タグの最初の要素 */
console.log(liElements[0].textContent); // 0から始まるインデックスでアクセス
// 出力: "おにぎり"
</script>
</body>
</html>
一致する要素の数を確認する
一致する要素の数は、lengthプロパティで簡単に確認できます。
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<title>getElementsByTagName().length</title>
</head>
<body>
<h1>getElementsByTagName().length</h1>
<ul>
<li>おにぎり</li>
<li>ラーメン</li>
<li>うどん</li>
</ul>
<script>
const liElements = document.getElementsByTagName("li"); // liタグをすべて取得
console.log(liElements.length); // 出力: 3
</script>
</body>
</html>
特定の要素内から要素を探す
getElementById()メソッドはdocumentオブジェクトでのみ使用できるメソッドですが、getElementsByTagName()メソッドはdocumentオブジェクトだけでなく、特定の要素(Element)オブジェクト内でも使用できます。
<!DOCTYPE html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<title>element.getElementsByTagName()</title>
</head>
<body>
<h1>element.getElementsByTagName()</h1>
<h2>日本のレストランメニュー</h2>
<ul>
<li>おにぎり</li>
<li>ラーメン</li>
<li>うどん</li>
</ul>
<h2>イタリアのレストランメニュー</h2>
<div id="cn-food">
<ul>
<li>ピザ</li>
<li>スパゲッティ</li>
<li>サラダ</li>
</ul>
</div>
<script>
const cnFood = document.getElementById("cn-food");
// idが "cn-food" の要素内からliタグをすべて取得
const cnFoodLiElements = cnFood.getElementsByTagName("li");
// 取得したすべての要素のうち、最初の要素のテキストコンテンツを出力
console.log(cnFoodLiElements[0].textContent); // 出力: "ピザ"
</script>
</body>
</html>
ブラウザーの互換性
| メソッド |
デスクトップ Chrome
|
デスクトップ Edge
|
デスクトップ Firefox
|
Safari
|
|---|---|---|---|---|
getElementsByTagName()
|
1 | 12 | 1 | 1 |
仕様書
| 仕様書 | |
|---|---|
document.getElementsByTagName()
|
DOM Standard #ref-for-dom-document-getelementsbytagname① |
element.getElementsByTagName()
|
DOM Standard #dom-element-getelementsbytagname |