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

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

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

基本的な使い方

setAttributeメソッドは、DOMElementオブジェクトに対して、指定された名前と値を持つ新しい属性を追加、または既存の属性の値を変更するメソッドです。このメソッドは、XMLドキュメントの要素に属性を動的に設定する際に非常に役立ちます。例えば、HTMLドキュメント内の<a>要素のhref属性をJavaScriptから変更するような処理を、PHPでサーバーサイドから行う場合に使用できます。

setAttributeメソッドは、属性名と属性値の2つの引数を受け取ります。属性名は文字列で指定し、大文字小文字は区別されます。属性値も文字列で指定します。もし指定された名前の属性が既に存在する場合、その属性の値は新しい値で上書きされます。存在しない場合は、新しい属性が要素に追加されます。

このメソッドは、属性が正常に設定された場合は何も返しません (void)。しかし、属性の設定に失敗した場合、例外をスローする可能性があります。例えば、XMLドキュメントが読み取り専用である場合や、属性名がXMLの命名規則に違反している場合などが考えられます。

setAttributeメソッドを使用する際は、属性名と属性値が適切であることを確認することが重要です。特に、ユーザーからの入力に基づいて属性を設定する場合は、クロスサイトスクリプティング（XSS）などのセキュリティリスクを避けるために、入力値のエスケープ処理を適切に行う必要があります。また、DOMDocumentオブジェクトのpreserveWhiteSpaceプロパティの設定によっては、空白文字の扱いが異なる場合があるので注意が必要です。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$element = $dom->createElement('example');
4$element->setAttribute('attribute_name', 'attribute_value');
5$dom->appendChild($element);
6echo $dom->saveXML();
7?>

引数(parameters)

string $qualifiedName, string $value

string $qualifiedName: 設定する属性の名前を指定する文字列
string $value: 設定する属性の値を指定する文字列

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP DOMElement setAttribute で要素属性を設定する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMElement::setAttribute を使用してHTML要素の属性を設定するサンプル
7 *
8 * この関数は、指定されたHTML文字列を解析し、
9 * h1要素とp要素に新しい属性を追加・更新して、結果を出力します。
10 */
11function setHtmlElementAttribute(): void
12{
13    // 1. 操作対象となるHTML文字列を準備します
14    $html = <<<HTML
15<!DOCTYPE html>
16<html lang="ja">
17<head>
18    <meta charset="UTF-8">
19    <title>サンプル</title>
20</head>
21<body>
22    <h1>見出し</h1>
23    <p>これは段落です。</p>
24</body>
25</html>
26HTML;
27
28    // 2. DOMDocumentオブジェクトを作成し、HTMLを読み込みます
29    $dom = new DOMDocument();
30    // HTML5のタグなどで警告が出ないように、エラー出力を抑制します
31    libxml_use_internal_errors(true);
32    $dom->loadHTML($html);
33    libxml_clear_errors();
34
35    // 3. h1要素を取得します (getElementsByTagNameはDOMNodeListを返します)
36    // item(0)でリストの最初の要素を取得します
37    $h1Element = $dom->getElementsByTagName('h1')->item(0);
38
39    // 4. h1要素（DOMElement）に属性を設定します
40    if ($h1Element instanceof DOMElement) {
41        // setAttribute() を使い、'id' という名前の属性に 'main-title' という値を設定します
42        $h1Element->setAttribute('id', 'main-title');
43
44        // 同様に 'class' 属性も設定します
45        $h1Element->setAttribute('class', 'important');
46    }
47
48    // 5. p要素を取得し、属性を設定します
49    $pElement = $dom->getElementsByTagName('p')->item(0);
50    if ($pElement instanceof DOMElement) {
51        // style属性を追加します
52        $pElement->setAttribute('style', 'color: blue;');
53        
54        // もし同じ名前の属性が既に存在する場合、setAttribute() はその値を上書きします
55        $pElement->setAttribute('style', 'color: red; font-weight: bold;');
56    }
57
58    // 6. 変更が適用されたHTMLを出力します
59    // saveHTML() はドキュメント全体を文字列として返します
60    echo $dom->saveHTML();
61}
62
63// 関数を実行
64setHtmlElementAttribute();
65

PHPのDOMElement::setAttributeメソッドは、HTMLやXMLドキュメント内の特定の要素（DOMElement）に対して、新しい属性を追加したり、既存の属性の値を更新したりするために使用されます。このメソッドは、Webページの動的な変更やXMLデータの操作において非常に重要な役割を果たします。

setAttributeメソッドは、二つの引数を取ります。最初の引数$qualifiedNameには、設定したい属性の名前を文字列で指定します。例えば、HTMLのidやclass、styleといった属性名です。二番目の引数$valueには、その属性に設定したい値を文字列で指定します。このメソッドは、属性の設定が成功したかどうかに関わらず、特に値を返しません（戻り値なし）。

サンプルコードでは、まずHTML文字列をDOMDocumentオブジェクトとして読み込み、操作対象となるh1要素やp要素を取得しています。取得した要素がDOMElement型であることを確認した後、setAttributeメソッドを呼び出して属性を設定します。例えば、$h1Element->setAttribute('id', 'main-title');と記述することで、<h1>要素にid="main-title"という属性が追加されます。

また、$pElement->setAttribute('style', 'color: red; font-weight: bold;');のように、もし同じ属性名（例: style）でsetAttributeを複数回呼び出した場合、後の呼び出しで指定された値が以前の値を上書きします。これにより、HTML要素の見た目や振る舞いをプログラムから柔軟に制御できるようになります。

setAttributeメソッドは、指定した属性が既に存在する場合、その値を新しい値で上書きしますのでご注意ください。HTML要素を操作する際は、まずDOMDocumentで目的の要素を正確に取得することが重要です。getElementsByTagNameなどで要素を取得する際、対象が見つからなければnullが返される可能性があります。そのため、setAttributeを呼び出す前に、必ずDOMElementのインスタンスであるかを確認する習慣をつけましょう。確認を怠ると、nullに対してメソッドを呼び出してしまい、プログラムが停止する原因となります。また、setAttribute自体は戻り値がないため、結果を代入することはできません。HTML解析時のエラー抑制は開発時には有用ですが、本番環境ではエラー内容を把握するため、より詳細なエラーハンドリングを検討してください。

PHP DOMElement::setAttribute で属性を追加する


1<?php
2
3/**
4 * DOMElement::setAttribute メソッドの使用例を示します。
5 * このメソッドは、指定された要素に新しい属性を追加するか、既存の属性の値を変更するために使用されます。
6 */
7
8// 1. DOMDocument オブジェクトを作成します。
9// '1.0' はXMLバージョン、'UTF-8' はエンコーディングを指定します。
10$dom = new DOMDocument('1.0', 'UTF-8');
11
12// 出力されるHTMLを見やすくするために、フォーマットを有効にします。
13$dom->formatOutput = true;
14
15// 2. 'h1' 要素を作成します。
16$h1Element = $dom->createElement('h1');
17
18// 3. 'h1' 要素のテキストコンテンツを設定します。
19$h1Element->textContent = 'PHP DOMElement::setAttribute の例';
20
21// 4. 'h1' 要素に 'id' 属性を設定します。
22// setAttribute(属性名, 属性値) の形式で属性を設定します。
23$h1Element->setAttribute('id', 'mainTitle');
24
25// 5. 'h1' 要素に 'class' 属性も設定します。
26// 複数の属性を設定することができます。
27$h1Element->setAttribute('class', 'heading primary');
28
29// 6. 作成した 'h1' 要素をDOMドキュメントに追加します。
30// ここではドキュメントのルート要素として追加しています。
31$dom->appendChild($h1Element);
32
33// 7. 完成したDOMツリーをHTML文字列として出力します。
34// DOMDocument::saveHTML() はDOMツリー全体をHTMLとして返します。
35echo $dom->saveHTML();
36
37/*
38上記のコードを実行すると、以下のHTMLが出力されます。
39（フォーマットは環境により異なる場合があります）
40
41<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
42<html><body><h1 id="mainTitle" class="heading primary">PHP DOMElement::setAttribute の例</h1></body></html>
43
44DOMDocumentのデフォルトの動作により、<html>と<body>タグが自動的に追加されることがあります。
45*/

PHPのDOMElement::setAttributeメソッドは、HTMLやXML文書の要素（タグ）に新しい属性を追加したり、既存の属性の値を変更したりするために利用されます。このメソッドを使用することで、プログラムからWebページの見た目や動作を細かく制御できるようになります。

このメソッドは二つの引数を取ります。一つ目の$qualifiedNameは、設定したい属性の名前を文字列で指定します（例: 'id'や'class'など）。二つ目の$valueは、その属性に設定する値を文字列で指定します。例えば、setAttribute('id', 'mainTitle')と記述すると、対象の要素にid="mainTitle"という属性が追加されます。

setAttributeメソッドは戻り値を持ちません。これは、呼び出し元のDOMElementオブジェクト自体が変更され、その状態が直接更新されるためです。

サンプルコードでは、まずDOMDocumentオブジェクトで文書全体を管理する準備をします。次に<h1>要素を作成し、その$h1Elementに対してsetAttributeメソッドを複数回呼び出しています。具体的にはid属性とclass属性を設定しており、これによりHTMLの<h1>タグにid="mainTitle"とclass="heading primary"が追加されます。最終的に、これらの属性が設定されたHTMLが生成され、出力されます。このように、setAttributeは要素のカスタマイズに不可欠なメソッドです。

DOMElement::setAttributeは、HTML要素に新しい属性を追加したり、既存の属性値を変更したりする際に利用します。同じ属性名で複数回このメソッドを呼び出すと、属性値は後から設定したもので上書きされるためご注意ください。引数には属性名と属性値をそれぞれ文字列で指定しますが、このメソッド自体は値を返しません。サンプルコードでは、DOMDocumentやcreateElementといった他のDOM操作メソッドと連携し、一連の流れでHTML構造を構築しています。完成したDOMツリーをsaveHTML()でHTML文字列として出力する際、DOMDocumentのデフォルトの動作により<html>や<body>タグなどが自動的に追加されることがありますので、出力結果を確認するようにしてください。