【PHP8.x】Dom\HTMLElement::getAttribute()メソッドの使い方

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

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

基本的な使い方

getAttributeメソッドは、DOM要素（HTMLElement）から指定された名前の属性の値を取得するメソッドです。このメソッドは、PHPのDOM拡張モジュールの一部であり、HTMLやXMLドキュメントをプログラムで操作する際に非常に役立ちます。

getAttributeメソッドは、対象となるDOM要素が持つ属性の名前を引数として受け取ります。例えば、HTML要素 <img src="image.jpg" alt="A beautiful image"> があった場合、getAttribute('src') を呼び出すと "image.jpg" が、getAttribute('alt') を呼び出すと "A beautiful image" が返されます。

もし指定された名前の属性が要素に存在しない場合、getAttributeメソッドは null を返します。これにより、属性の存在を事前に確認せずに値を取得し、null チェックを行うことで、存在しない属性へのアクセスを安全に処理できます。

getAttributeメソッドは、大文字と小文字を区別します。つまり、getAttribute('SRC') は getAttribute('src') とは異なる属性として扱われます。HTML属性名は大文字小文字を区別しないとされていますが、DOM APIとしては区別される点に注意が必要です。

getAttributeメソッドは、主にDOMDocumentオブジェクトによって作成されたDOM要素に対して使用されます。DOMDocumentオブジェクトは、HTMLやXMLドキュメントを解析し、その構造をツリー状のオブジェクトとして表現します。getAttributeメソッドを使用することで、このツリー構造内の特定の要素から属性値を効率的に取得できます。

システムエンジニアは、getAttributeメソッドを利用することで、ウェブスクレイピングやウェブページの自動処理、XMLデータの解析など、様々なタスクを自動化できます。例えば、ウェブサイトから特定の情報を抽出したり、XMLファイルから設定値を読み込んだりする際に、getAttributeメソッドが重要な役割を果たします。

構文(syntax)


1Dom\HTMLElement::getAttribute(string $qualifiedName): string|null

引数(parameters)

string $qualifiedName

string $qualifiedName: 取得したい属性の名前を文字列で指定します。大文字・小文字は区別されません。

戻り値(return)

?string

指定された属性名に対応する属性値（文字列）を返します。属性が存在しない場合は null を返します。

サンプルコード

PHP DOMDocumentでHTML属性を取得する


1<?php
2
3// HTMLドキュメントを読み込む
4$dom = new DOMDocument();
5$dom->loadHTML('<html><body><div id="container" class="main">Hello, World!</div></body></html>');
6
7// 'container'というIDを持つ要素を取得
8$element = $dom->getElementById('container');
9
10// 'class'属性の値を取得
11if ($element instanceof DOMElement) {
12    $class_attribute = $element->getAttribute('class');
13
14    // 属性が存在する場合、値を出力
15    if ($class_attribute !== null) {
16        echo "Class attribute: " . $class_attribute . "\n"; // 出力: Class attribute: main
17    } else {
18        echo "Class attribute not found.\n";
19    }
20
21    // 存在しない属性を取得しようとする
22    $nonexistent_attribute = $element->getAttribute('data-value');
23
24    // 存在しない属性の場合、nullが返される
25    if ($nonexistent_attribute === null) {
26        echo "data-value attribute not found.\n"; // 出力: data-value attribute not found.
27    }
28}
29
30?>

このサンプルコードは、PHPのDOM拡張を用いて、HTML要素から指定した属性の値を取得する方法を示しています。Dom\HTMLElementクラスのgetAttributeメソッドを使用します。

まず、DOMDocumentクラスのインスタンスを作成し、loadHTMLメソッドでHTMLドキュメントを読み込みます。次に、getElementByIdメソッドで、'container'というIDを持つ要素（div要素）を取得します。

getAttributeメソッドは、引数に属性の名前（ここでは'class'）を文字列で指定し、その属性の値を返します。もし指定した属性が存在しない場合、nullを返します。

サンプルコードでは、まず'class'属性の値を取得し、その値が存在するかどうかを確認しています。'class'属性が存在する場合は、その値（"main"）を出力します。

次に、存在しない属性（'data-value'）を指定してgetAttributeメソッドを呼び出しています。この場合、nullが返されるため、属性が見つからなかった旨のメッセージを出力します。

getAttributeメソッドは、HTML要素の属性値を動的に取得する際に非常に便利です。例えば、CSSクラスに基づいて要素のスタイルを変更したり、data属性から情報を読み取ったりする場合などに活用できます。戻り値が?string型であるため、取得する属性が存在しない場合にnullが返ってくることを考慮した実装が必要です。

getAttributeメソッドは、指定した属性名を持つ属性の値を文字列で返します。もし属性が存在しない場合はnullを返す点に注意が必要です。DOMElementオブジェクトに対してのみ使用できるメソッドなので、事前にinstanceofで型を確認することを推奨します。属性値を取得する際には、HTML文書の構造や属性名の大文字・小文字を正確に把握しておく必要があります。存在しない属性名を指定した場合にエラーが発生するわけではありませんが、nullが返ってくるため、nullチェックを行うことで、より安全なコードになります。また、getAttributeメソッドはセキュリティ上のリスクを考慮し、外部からの入力を直接属性値として使用しないように注意してください。