【PHP8.x】DOMElement::getAttributeNames()メソッドの使い方

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

作成日: 2025年09月11日更新日: 2025年11月18日

基本的な使い方

getAttributeNamesメソッドは、DOMElementオブジェクトが表す要素に設定されているすべての属性の名前を取得するメソッドです。PHPでHTMLやXMLドキュメントを操作する際に、特定の要素がどのような属性を持っているかを知りたい場合に非常に役立ちます。このメソッドを呼び出すと、対象の要素が持つ属性の名前が文字列の配列として返されます。例えば、HTMLドキュメント内の<img src="image.jpg" alt="Description">のような要素に対してこのメソッドを適用すると、['src', 'alt']といった配列が結果として得られます。

対象の要素に属性が一つも設定されていない場合でも、このメソッドはエラーを発生させることなく空の配列を返します。この挙動により、属性の有無を事前に確認する手間を省き、安全かつ一貫した方法で属性名の一覧を取得し、後続の処理に進むことができます。取得した属性名を使って、各属性の値を取得したり、特定の属性が存在するかどうかを確認したりする際に利用されます。ウェブページからの情報抽出（スクレイピング）や、XML形式の設定ファイルを動的に解析する処理など、要素の属性をプログラムで柔軟に扱う必要がある場面で、getAttributeNamesメソッドは効率的で堅牢なコードの実装を支援する重要な機能です。PHP 8環境において、DOM操作における基本的ながらも強力なツールの一つとして活用されます。

構文(syntax)


1<?php
2
3$html = '<div id="main-content" class="container" lang="ja" data-type="article"></div>';
4
5$doc = new DOMDocument();
6$doc->loadHTML($html);
7
8$element = $doc->getElementsByTagName('div')->item(0);
9
10// DOMElementからすべての属性名を取得します
11$attributeNames = $element->getAttributeNames();
12
13print_r($attributeNames);

引数(parameters)

引数なし

引数はありません

戻り値(return)

array

DOMElement オブジェクトが持つ全ての属性の名前を文字列の配列として返します。

サンプルコード

PHP DOMElement getAttributeNamesで属性名一覧を取得する


1<?php
2
3// DOMDocumentオブジェクトを作成します。
4// これを使ってHTMLドキュメントを読み込み、操作します。
5$dom = new DOMDocument();
6
7// 処理するHTML文字列を定義します。
8// この例では、複数の属性を持つdiv要素を作成します。
9$htmlContent = '<div id="main-section" class="content-box" data-custom-id="12345" title="メインセクション">
10                    <p>これはテスト用の段落です。</p>
11                </div>';
12
13// HTML文字列をDOMDocumentに読み込みます。
14// loadHTML()はHTMLをパースし、DOMツリーを構築します。
15@$dom->loadHTML($htmlContent); // エラー表示を抑制するために@を使用
16
17// ドキュメント内の特定の要素を取得します。
18// getElementsByTagNameは指定されたタグ名を持つすべての要素のDOMNodeListを返します。
19// 今回は最初のdiv要素を取得するため、item(0)を使用します。
20$targetElement = $dom->getElementsByTagName('div')->item(0);
21
22// 取得した要素がDOMElementのインスタンスであることを確認します。
23// 要素が見つからなかった場合に備えて、このチェックは重要です。
24if ($targetElement instanceof DOMElement) {
25    echo "取得した要素のタグ名: " . $targetElement->tagName . "\n";
26
27    // DOMElement::getAttributeNames() メソッドを使用して、
28    // 要素が持つすべての属性の名前の配列を取得します。
29    $attributeNames = $targetElement->getAttributeNames();
30
31    echo "この要素の属性名一覧:\n";
32    // 取得した属性名の配列をループして、一つずつ表示します。
33    foreach ($attributeNames as $name) {
34        echo "- " . $name . "\n";
35    }
36} else {
37    echo "指定されたdiv要素が見つかりませんでした。\n";
38}
39
40?>

このサンプルコードは、PHPのDOM拡張機能を使用して、HTML要素が持つ属性の名前を一覧で取得する方法を示しています。

まず、DOMDocumentクラスのオブジェクトを作成し、読み込みたいHTML文字列をloadHTML()メソッドで解析しています。DOMDocumentはHTMLやXMLドキュメント全体を表現し、その内容を操作するための基盤となります。

次に、解析されたドキュメントの中から、getElementsByTagName()メソッドを使って目的のdiv要素を取得し、$targetElementとして保持しています。この$targetElementは、DOMElementクラスのインスタンスとなります。DOMElementは、個々のHTML要素（タグ）を表すオブジェクトです。

そして、このDOMElementインスタンスに対してgetAttributeNames()メソッドを呼び出しています。このメソッドは引数を取りません。呼び出すと、その要素に設定されている「id」「class」「data-custom-id」「title」といったすべての属性の名前を文字列の配列として返します。

サンプルコードでは、戻り値として得られた属性名の配列をforeachループで一つずつ取り出し、コンソールに表示しています。このgetAttributeNames()メソッドを使うことで、あるHTML要素がどのような属性を持っているかを動的に調べることができ、属性値の取得や変更を行う際の足がかりとして非常に有用です。

サンプルコードの@は、HTMLのパースエラーを非表示にするために使われますが、開発やデバッグ時にはエラー内容を確認できるよう、使用を避けてください。getAttributeNamesメソッドはPHP 8.0以降で導入された機能ですので、利用するPHPバージョンを確認することが重要です。getElementsByTagNameで要素を取得する際、対象が見つからないとnullが返されるため、必ずif ($targetElement instanceof DOMElement)のように要素の存在と型をチェックし、予期せぬ実行時エラーを防ぐようにしてください。また、要素に属性が一つもない場合、このメソッドは空の配列を返しますので、その点も考慮して処理を作成すると良いでしょう。

DOMElementから属性名を取得する


1<?php
2
3// DOMDocumentを新規作成します
4$dom = new DOMDocument();
5
6// 属性を持つHTMLコンテンツを読み込みます
7// LIBXML_HTML_NOIMPLIEDとLIBXML_HTML_NODEFDTDは、不要な<html>や<body>タグの自動追加を防ぎます
8// @ suppresses warnings about missing doctype for simple examples
9@$dom->loadHTML('<div id="header" class="main-nav" data-type="primary">Welcome!</div>', LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
10
11// ドキュメント内の最初のdiv要素を取得します
12$divElement = $dom->getElementsByTagName('div')->item(0);
13
14// 要素が正しく取得できたか確認します
15if ($divElement instanceof DOMElement) {
16    // DOMElement::getAttributeNames() を使用して、要素のすべての属性名を取得します
17    $attributeNames = $divElement->getAttributeNames();
18
19    echo "取得したdiv要素の属性名:\n";
20    foreach ($attributeNames as $name) {
21        echo "- " . $name . "\n";
22    }
23} else {
24    echo "指定されたdiv要素が見つかりませんでした。\n";
25}

このPHPコードは、HTML要素が持っている属性の名前をすべて取得する方法を示しています。

まず、DOMDocumentクラスの新しいインスタンスを作成し、属性を持つシンプルなHTMLコンテンツを読み込んでいます。このHTMLには、id、class、data-typeという3つの属性を持つdiv要素が含まれています。LIBXML_HTML_NOIMPLIEDやLIBXML_HTML_NODEFDTDといったオプションは、不要なHTML構造の自動追加を防ぐために使用されています。

次に、読み込んだドキュメントの中から最初のdiv要素を特定し、$divElementという変数に代入しています。

DOMElement::getAttributeNames()メソッドは、この取得したHTML要素（ここではdiv要素）が持つすべての属性の名前を一覧で取得するために使用されます。このメソッドは引数を必要とせず、要素に存在する属性名を文字列の配列として返します。

コードでは、取得した属性名の配列をforeachループで繰り返し処理し、それぞれの属性名を画面に表示しています。これにより、「id」や「class」、「data-type」といった属性名が順番に出力されることがわかります。

この機能は、HTML構造をプログラムで解析し、特定の要素がどのような属性を持っているかを動的に把握したい場合に非常に役立ちます。

このサンプルコードは、HTML要素の属性名を取得するDOMElement::getAttributeNames()メソッドの使用例です。要素を取得する際には、getElementsByTagName()などの結果がnullになる可能性があるため、必ずif ($divElement instanceof DOMElement)のように、取得した変数がDOMElement型であることを確認してください。これにより、要素が見つからなかった場合の不必要なエラー発生を防げます。また、サンプルコードで使用されている@演算子は警告を一時的に抑制しますが、実運用ではエラー抑制ではなく、エラーの原因を特定し適切に処理することが推奨されます。取得した属性名は配列で返されますので、foreachループで各属性名を取り出して利用できます。複雑なHTMLを扱う際には、文字エンコーディングにも注意が必要です。