【PHP8.x】getElementsByTagNameメソッドの使い方

getElementsByTagNameメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

getElementsByTagNameメソッドは、DOMDocumentまたはDOMElementオブジェクトの子孫要素の中から、指定されたタグ名を持つすべての要素をDOMNodeListオブジェクトとして取得するメソッドです。このメソッドを使用することで、HTMLやXMLドキュメント内の特定の種類の要素を効率的に検索し、操作することができます。

具体的には、メソッドを呼び出すオブジェクト(例えば、DOMDocumentオブジェクト)を起点として、その子孫要素を再帰的に検索します。引数には検索したい要素のタグ名を文字列で指定します。例えば、"p"を指定すると、すべての<p>要素が検索されます。"*"を指定すると、すべての要素が検索されます。

返り値はDOMNodeListオブジェクトであり、これには見つかった要素が順番に格納されています。DOMNodeListオブジェクトは配列のようにアクセスできますが、厳密には配列ではありません。そのため、count()関数などを使用して要素の数を取得したり、foreachループで要素を順番に処理したりできます。

このメソッドは、HTMLやXMLドキュメントの構造を解析し、特定の要素を抽出する際に非常に役立ちます。例えば、Webページ内のすべてのリンク(<a>要素)を取得して、そのhref属性を調べたり、特定のクラス名を持つすべての要素を検索して、その内容を変更したりするなどの用途に利用できます。システムエンジニアがWebスクレイピングやXMLデータの処理を行う際に、頻繁に使用する重要なメソッドの一つです。

構文(syntax)

1Dom\HTMLDocument::getElementsByTagName(string $qualifiedName): Dom\NodeList

引数(parameters)

string $qualifiedName

  • string $qualifiedName: 検索する要素のタグ名を指定する文字列

戻り値(return)

Dom\HTMLCollection

指定されたタグ名に一致するすべての要素のコレクションが返されます。

サンプルコード

PHPで複数タグの要素を取得する

1<?php
2
3// HTML文字列を読み込み、特定のタグを持つ要素を取得するサンプル
4function getElementsByTagNames(string $html, array $tagNames): array
5{
6    $dom = new DOMDocument();
7    // HTMLの解析エラーを抑制
8    libxml_use_internal_errors(true);
9    $dom->loadHTML($html);
10    libxml_clear_errors();
11
12    $results = [];
13    foreach ($tagNames as $tagName) {
14        $elements = $dom->getElementsByTagName($tagName);
15        foreach ($elements as $element) {
16            $results[] = $element;
17        }
18    }
19
20    return $results;
21}
22
23// HTMLの例
24$html = <<<HTML
25<!DOCTYPE html>
26<html>
27<head>
28    <title>Example</title>
29</head>
30<body>
31    <h1>Hello, world!</h1>
32    <p>This is a paragraph.</p>
33    <div>This is a div.</div>
34    <span>This is a span.</span>
35    <p>Another paragraph.</p>
36</body>
37</html>
38HTML;
39
40// 取得したいタグ名
41$tagNames = ['p', 'div'];
42
43// タグ名に基づいて要素を取得
44$elements = getElementsByTagNames($html, $tagNames);
45
46// 取得した要素を表示
47foreach ($elements as $element) {
48    echo $element->tagName . ': ' . $element->textContent . PHP_EOL;
49}

このサンプルコードは、PHPのDOM拡張を用いて、HTML文字列から複数のタグ名を持つ要素を効率的に抽出する方法を示しています。Dom\HTMLDocumentクラスのgetElementsByTagNameメソッドを利用し、指定したタグ名を持つ要素をDom\HTMLCollectionとして取得します。

まず、getElementsByTagNames関数は、HTML文字列とタグ名の配列を引数として受け取ります。内部では、DOMDocumentオブジェクトを生成し、loadHTMLメソッドを使ってHTML文字列を解析します。libxml_use_internal_errors(true)libxml_clear_errors()は、HTML解析時のエラーを抑制するために使用されています。

次に、与えられたタグ名の配列をループ処理し、各タグ名に対してgetElementsByTagNameメソッドを呼び出します。getElementsByTagNameメソッドは、指定されたタグ名を持つすべての要素をDom\HTMLCollectionオブジェクトとして返します。このコレクションをさらにループ処理し、取得した各要素を結果の配列に追加します。

サンプルコードでは、$tagNames配列に'p''div'を指定することで、HTML文字列中の<p>タグと<div>タグを持つ要素をすべて取得しています。最後に、取得した要素のタグ名と内容を順番に出力します。$element->tagNameでタグ名を取得し、$element->textContentで要素のテキストコンテンツを取得できます。このコードは、特定のタグを持つ要素を効率的に抽出する基本的な方法を理解するのに役立ちます。

getElementsByTagNameメソッドは、指定したタグ名の要素をすべて取得します。複数のタグ名をまとめて取得したい場合は、サンプルコードのようにループ処理が必要です。HTMLにエラーがあると、loadHTMLで警告が出ることがあります。libxml_use_internal_errors(true)libxml_clear_errors()でエラーを抑制し、後で確認するようにしましょう。取得した要素はDOMElementオブジェクトであり、tagNameでタグ名、textContentで要素内のテキストを取得できます。innerHTMLに相当するプロパティはないため、子要素を含めたHTML全体を取得したい場合は、saveHTML($element)を使用します。このメソッドは、HTML文書全体を解析するため、大きなHTMLに対してはパフォーマンスに影響が出る可能性があります。

PHP DOMDocumentでタグ名から要素を取得する

1<?php
2
3// HTML文字列を読み込む
4$htmlString = <<<HTML
5<!DOCTYPE html>
6<html>
7<head>
8    <title>getElementsByTagName Example</title>
9</head>
10<body>
11    <h1>見出し</h1>
12    <p>最初の段落。</p>
13    <p>2番目の段落。</p>
14    <div>
15        <p>divの中の段落</p>
16    </div>
17</body>
18</html>
19HTML;
20
21// DOMDocumentオブジェクトを作成
22$dom = new DOMDocument();
23
24// HTMLをロード
25$dom->loadHTML($htmlString);
26
27// bodyタグの要素を取得
28$elements = $dom->getElementsByTagName('body');
29
30// 取得した要素の数を出力
31echo "bodyタグの数: " . $elements->length . "\n";
32
33// pタグの要素を取得
34$elements = $dom->getElementsByTagName('p');
35
36// 取得した要素の数を出力
37echo "pタグの数: " . $elements->length . "\n";
38
39// 取得した要素をループして内容を出力
40foreach ($elements as $element) {
41    echo "pタグの内容: " . $element->textContent . "\n";
42}

このPHPのサンプルコードは、Dom\HTMLDocumentクラスのgetElementsByTagNameメソッドの使い方を示しています。getElementsByTagNameメソッドは、指定されたタグ名を持つ要素を全て取得し、Dom\HTMLCollectionオブジェクトとして返します。引数$qualifiedNameには、取得したい要素のタグ名を文字列で指定します。

まず、DOMDocumentオブジェクトを作成し、HTML文字列をloadHTMLメソッドで読み込みます。次に、getElementsByTagName('body')でbodyタグの要素を取得し、その数を$elements->lengthで出力します。同様に、getElementsByTagName('p')でpタグの要素を取得し、その数を出力します。

取得したpタグの要素はDom\HTMLCollectionオブジェクトとして格納されているため、foreachループを使って各要素を取り出し、$element->textContentで要素の内容(テキスト)を取得して出力しています。textContentプロパティは、要素内のテキストノードの値を結合したものを返します。

このサンプルコードでは、HTML文字列から特定のタグを持つ要素を効率的に取得し、操作する方法を学ぶことができます。getElementsByTagNameメソッドは、HTMLドキュメントの構造を解析し、特定の要素を抽出する際に非常に役立ちます。

getElementsByTagNameメソッドは、指定されたタグ名を持つすべての要素をDOMNodeListとして返します。このリストは、ドキュメント内の要素が現れる順序で並んでいます。

注意点として、タグ名は大文字小文字を区別しません。また、返されるのはDOMNodeListオブジェクトであり、配列ではありません。そのため、count()関数ではなく$elements->lengthプロパティで要素の数を取得する必要があります。

foreachで要素を処理する際は、各要素がDOMElementオブジェクトであることに注意してください。textContentプロパティを使って、要素の内容(テキスト部分)を取得できます。

このメソッドはHTML構造に依存するため、HTMLが正しく構造化されていることを確認してください。不正なHTMLの場合、期待どおりの結果が得られない可能性があります。

【PHP8.x】getElementsByTagNameメソッドの使い方 | いっしー@Webエンジニア