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

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

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

基本的な使い方

createAttributeメソッドは、Dom\HTMLDocumentクラスに属し、新しい属性ノード（DOMAttrオブジェクト）を作成するために実行するメソッドです。このメソッドは、HTMLドキュメント内の要素に対してプログラム的に属性を追加したい場合に利用されます。引数には、作成したい属性の名前を文字列で指定します。例えば、「id」や「class」といった属性の名前を渡すことで、それらの名前を持つDOMAttrオブジェクトが新しく生成され、戻り値として返されます。

このメソッドが作成するのは属性ノードそのものであり、これだけではドキュメント内のどの要素にも関連付けられません。作成されたDOMAttrオブジェクトは、その後、目的のDOMElementオブジェクトが持つsetAttributeNodeメソッドなどを用いて、明示的にその要素へ追加する必要があります。このプロセスを分離することで、HTMLドキュメントの構造を柔軟に操作できるようになります。

例えば、特定の<div>要素にdata-status属性を追加する場合、まずcreateAttribute('data-status')で属性ノードを作成します。次に、作成したDOMAttrオブジェクトのvalueプロパティに適切な値を設定し、最後に<div>要素に対してsetAttributeNodeメソッドでこの属性を追加します。createAttributeメソッドは、HTML要素の属性を動的に構築・管理するための基盤となる重要な機能です。

構文(syntax)


1<?php
2
3$document = new Dom\HTMLDocument();
4$attribute = $document->createAttribute('id');
5
6?>

引数(parameters)

string $localName

string $localName: 作成する属性の名前を指定する文字列

戻り値(return)

Dom\Attr

このメソッドは、指定された名前を持つ新しい属性ノードを生成し、Dom\Attr オブジェクトとして返します。

サンプルコード

Dom\HTMLDocument::createAttributeNS を使用して名前空間付き属性を作成する


1<?php
2
3/**
4 * Dom\HTMLDocument::createAttributeNS を使用して、
5 * 名前空間付きの属性を作成し、要素に追加するサンプルです。
6 */
7function demonstrateCreateAttributeNS(): void
8{
9    // 操作対象となるHTMLコンテンツ
10    $html = <<<'HTML'
11<!DOCTYPE html>
12<html lang="ja">
13<head>
14    <meta charset="UTF-8">
15    <title>createAttributeNS Sample</title>
16</head>
17<body>
18    <div id="target">この要素に属性が追加されます。</div>
19</body>
20</html>
21HTML;
22
23    // 1. Dom\HTMLDocument オブジェクトを生成します。
24    // PHP 8 から導入された新しい ext/dom API を使用しています。
25    $doc = new Dom\HTMLDocument();
26
27    // 2. HTML文字列を読み込みます。
28    $doc->loadHTML($html);
29
30    // 3. 属性を追加したい要素を取得します。
31    $element = $doc->getElementById('target');
32
33    // 要素が見つかった場合のみ処理を実行
34    if ($element) {
35        // 4. 名前空間付きの属性 (Attrノード) を作成します。
36        // 第1引数: 名前空間のURI
37        // 第2引数: 修飾名 (プレフィックス:ローカル名)
38        $namespaceURI = 'http://www.example.com/ns/custom';
39        $qualifiedName = 'custom:data-id';
40        $attribute = $doc->createAttributeNS($namespaceURI, $qualifiedName);
41
42        // 5. 作成した属性に値を設定します。
43        $attribute->value = 'A-001';
44
45        // 6. 要素に属性ノードをセットします。
46        $element->setAttributeNode($attribute);
47    }
48
49    // 7. 変更が適用されたHTMLを出力します。
50    // ルート要素(<html>)に、名前空間の宣言(xmlns:custom)が自動的に追加されます。
51    echo $doc->saveHTML();
52}
53
54demonstrateCreateAttributeNS();

このサンプルコードは、PHPのDom\HTMLDocument::createAttributeNSメソッドを使用して、名前空間を持つ属性を生成し、HTML要素に追加する手順を示しています。

最初にnew Dom\HTMLDocument()でDOM操作の土台となるオブジェクトを作成し、loadHTML()でHTML文字列を解析します。次にgetElementById()を使い、属性を追加したいid="target"を持つ要素を取得します。

コードの中心となるcreateAttributeNS()メソッドは、名前空間に属する属性ノード（Dom\Attrオブジェクト）を新しく作成します。第1引数の$namespaceURIには、その属性がどのグループに属するかを識別するためのURIを指定します。第2引数の$qualifiedNameには、「プレフィックス:属性名」という形式で属性の修飾名を渡します。このメソッドは、作成された属性を表すDom\Attrオブジェクトを返します。

作成された属性オブジェクトのvalueプロパティに値を設定した後、setAttributeNode()メソッドで対象の要素にその属性を適用します。

最後にsaveHTML()で変更後のHTMLを出力すると、指定した要素にcustom:data-id属性が追加されていることが確認できます。このとき、ルートの<html>要素には、使用した名前空間を定義するためのxmlns:custom属性が自動的に付与されます。

このコードはPHP 8から導入された新しいDOM APIを使用しており、古いDOMDocumentクラスとは使い方が異なる点に注意が必要です。createAttributeNSは、属性名の衝突を避けるための「名前空間」付き属性を作成するメソッドです。第1引数の名前空間URIと、第2引数の修飾名（例: custom:data-id）がセットで重要な意味を持ちます。getElementByIdで要素を取得する際は、見つからない場合に備えて必ずnullチェックを行いましょう。これにより予期せぬエラーを防げます。作成した属性はsetAttributeNodeで要素に追加し、saveHTMLで出力すると、ルート要素に名前空間の宣言（xmlns:...）が自動的に追加される点も特徴です。