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

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

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

基本的な使い方

removeAttributeメソッドは、DOMElementノードから指定された属性を削除するメソッドです。DOM (Document Object Model) は、HTMLやXMLドキュメントをプログラムから操作するためのAPIであり、DOMElementはその要素（タグ）を表します。このメソッドを使用することで、要素に付与されている属性を動的に削除し、ドキュメントの構造や表示を変化させることができます。

removeAttributeメソッドは、削除したい属性の名前を引数として受け取ります。属性名は文字列で指定します。例えば、id属性やclass属性、カスタム属性などを削除できます。属性が存在しない場合は、何も起こりません。エラーも発生しません。

このメソッドは、DOMを操作する上で非常に重要な役割を果たします。例えば、JavaScriptと組み合わせて、ユーザーの操作に応じて要素の属性を削除することで、動的なWebページを作成できます。具体的には、ボタンをクリックした際に、特定の要素の表示・非表示を切り替えるために、style属性を変更したり、特定のクラスを削除したりする場合などに利用できます。

removeAttributeメソッドは、元のDOMElementオブジェクト自体を変更します。つまり、メソッドを呼び出したDOMElementオブジェクトの状態が直接変更されます。このため、DOMの構造を意図しない形で変更してしまう可能性もあるため、注意が必要です。

removeAttributeメソッドを使用する際には、削除する属性が本当に削除しても問題ないものかどうかを事前に確認することが重要です。特に、重要な機能やスタイルに関連する属性を削除してしまうと、Webページの動作に影響を与える可能性があります。また、複数の要素に同じ処理を適用する場合は、ループ処理などを用いて効率的にremoveAttributeメソッドを呼び出すことができます。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$element = $dom->createElement('test');
4$element->setAttribute('foo', 'bar');
5$element->removeAttribute('foo');
6?>

引数(parameters)

string $qualifiedName

string $qualifiedName: 削除する属性の名前を指定する文字列

戻り値(return)

戻り値なし

戻り値はありません

サンプルコード

PHP DOMElement::removeAttribute で属性を削除する


1<?php
2
3/**
4 * DOMElement::removeAttribute() の使用例
5 * 指定された要素から特定の属性を削除する方法を示します。
6 */
7function exampleRemoveAttribute(): void
8{
9    // 1. 新しい DOMDocument オブジェクトを作成
10    // HTML ドキュメントを操作するための基盤となります。
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    $dom->formatOutput = true; // 出力HTMLを見やすくフォーマット
13
14    // 2. ルート要素 (例: <div>) を作成し、ドキュメントに追加
15    // この要素に属性を設定し、後で削除します。
16    $divElement = $dom->createElement('div');
17    $dom->appendChild($divElement);
18
19    // 3. 要素に複数の属性を追加
20    // id 属性と class 属性を追加し、削除の対象とします。
21    $divElement->setAttribute('id', 'myContainer');
22    $divElement->setAttribute('class', 'example-class primary-style');
23    $divElement->setAttribute('data-status', 'active');
24
25    echo "--- 属性削除前の要素の状態 ---" . PHP_EOL;
26    // 現在の DOM の HTML 表現を出力して確認
27    echo $dom->saveHTML() . PHP_EOL . PHP_EOL;
28
29    // 4. DOMElement::removeAttribute() を使用して 'class' 属性を削除
30    // $qualifiedName (属性名) を文字列で指定します。
31    $divElement->removeAttribute('class');
32    echo "--- 'class' 属性削除後の要素の状態 ---" . PHP_EOL;
33    echo $dom->saveHTML() . PHP_EOL . PHP_EOL;
34
35    // 5. 別の属性 'data-status' も削除
36    $divElement->removeAttribute('data-status');
37    echo "--- 'data-status' 属性削除後の要素の状態 ---" . PHP_EOL;
38    echo $dom->saveHTML() . PHP_EOL . PHP_EOL;
39
40    // 存在しない属性を削除しようとしても、エラーは発生しません。
41    $divElement->removeAttribute('non-existent-attribute');
42    echo "--- 存在しない属性を削除しようとした後の要素の状態 (変更なし) ---" . PHP_EOL;
43    echo $dom->saveHTML() . PHP_EOL;
44}
45
46// サンプル関数を実行
47exampleRemoveAttribute();
48

PHPのDOMElement::removeAttribute()メソッドは、HTML要素から特定の属性を削除するために使用されるものです。

このサンプルコードでは、まず新しいDOMDocumentオブジェクトを作成し、その中にdiv要素を追加しています。次に、idやclass、data-statusといった複数の属性をdiv要素に設定し、属性削除前のHTMLの状態を出力して確認しています。

その後、removeAttribute()メソッドを使って特定の属性を削除する処理に移ります。このメソッドの引数$qualifiedNameには、削除したい属性名（例えば'class'や'data-status'）を文字列で指定します。メソッドが実行されても特に戻り値はありません。サンプルコードでは、各属性が削除されるたびにHTMLを出力し、属性が正しく取り除かれていることを示しています。

また、存在しない属性名を指定してremoveAttribute()を呼び出しても、PHP側でエラーは発生せず、要素の状態は変化しないことも確認できます。このメソッドは、ウェブページの内容を動的に変更する際に、特定のHTML要素から不要な属性を安全に取り除くために利用できます。

このメソッドは、指定されたDOM要素から特定の属性を削除するために使用します。引数には、削除したい属性の名前を文字列で正確に指定してください。最も重要な注意点として、もし指定した属性が要素に存在しなくても、エラーは発生せず、何も変更されません。そのため、事前に属性が存在するかどうかを確認する手間は不要です。このメソッドは戻り値を返しませんので、削除が成功したかどうかを直接取得することはできませんが、操作後のDOM状態を確認することで検証は可能です。HTMLコンテンツの動的な変更に役立ちます。

PHPで要素のclass属性を削除する


1<?php
2
3/**
4 * HTML要素から'class'属性を削除するサンプル関数。
5 *
6 * DOMElement::removeAttribute() メソッドを使用して、指定された要素から
7 * 完全な属性を削除する方法を示します。
8 * キーワード「php removeclass」は、多くの場合、要素のclass属性を操作する
9 * シナリオを指すため、ここではclass属性を完全に削除する例を示します。
10 */
11function removeClassAttributeFromElementExample(): void
12{
13    // 1. 新しいDOMDocumentオブジェクトを作成し、HTMLコンテンツを読み込む
14    // loadHTML() は完全なHTMLドキュメントとして解釈するため、自動的に<html><body>タグが追加されることがあります。
15    // エラーが表示されることを避けるため、@を付けて抑制しています。
16    $dom = new DOMDocument();
17    @$dom->loadHTML('
18        <div id="myElement" class="header highlight active">最初の要素</div>
19        <p class="intro">これは段落です。</p>
20        <span class="foo">別の要素</span>
21    ');
22
23    echo "--- 変更前のHTML --- \n";
24    echo $dom->saveHTML() . "\n\n";
25
26    // 2. DOMXPathを使用して、操作したい特定の要素を取得する
27    // ここでは、idが "myElement" のdiv要素を見つけます。
28    $xpath = new DOMXPath($dom);
29    $targetElement = $xpath->query('//div[@id="myElement"]')->item(0);
30
31    // 要素が見つかった場合のみ処理を進める
32    if ($targetElement instanceof DOMElement) {
33        echo "--- ターゲット要素が見つかりました --- \n";
34        echo "ターゲット要素（変更前）: " . $dom->saveHTML($targetElement) . "\n\n";
35
36        // 3. DOMElement::removeAttribute() メソッドを呼び出し、'class'属性を完全に削除する
37        // このメソッドは戻り値がありません。指定された属性が存在しない場合でもエラーにはなりません。
38        $targetElement->removeAttribute('class');
39
40        echo "--- 'class'属性削除後のHTML --- \n";
41        echo "ターゲット要素（変更後）: " . $dom->saveHTML($targetElement) . "\n\n";
42
43        echo "--- ドキュメント全体のHTML（最終） --- \n";
44        echo $dom->saveHTML() . "\n";
45    } else {
46        echo "エラー: id=\"myElement\" を持つ要素が見つかりませんでした。\n";
47    }
48}
49
50// サンプル関数を実行
51removeClassAttributeFromElementExample();
52

PHP 8で提供されるDOMElement::removeAttributeメソッドは、HTML要素から指定された属性を完全に削除するために使用されます。このメソッドはDOMElementクラスに属しており、HTMLドキュメントの構造を操作する際に非常に便利な機能を提供します。

引数にはstring $qualifiedNameを取り、削除したい属性の名前を文字列で指定します。例えば、HTML要素からclass属性を削除したい場合は、'class'と指定します。このメソッドには戻り値がなく（void）、指定された属性が存在しない場合でも特にエラーは発生しません。

サンプルコードでは、まずHTMLコンテンツをDOMDocumentに読み込み、DOMXPathを使って特定のdiv要素を取得しています。取得したDOMElementオブジェクトに対してremoveAttribute('class')を呼び出すことで、その要素に設定されていた全てのclass属性を完全に削除しています。これは「php removeclass」というキーワードで検索されるような、HTML要素からclass属性を操作する代表的なシナリオの一つです。この機能により、HTML要素から不要な属性を手軽に取り除くことが可能になります。

DOMElement::removeAttribute()は指定した属性を完全に削除するメソッドで、戻り値がないため、属性の削除成否や存在有無は直接確認できません。存在しない属性名を指定してもエラーは発生しません。このメソッドは属性値を部分的に変更する目的には適していません。例えば、class属性から特定のCSSクラスだけを削除する場合は、属性値を取得後に文字列操作で加工し、setAttribute()で更新する必要があります。DOMDocument::loadHTML()は不完全なHTMLを読み込む際、<html>や<body>タグなどを自動追加し、元のHTML構造が変わる可能性があります。また、DOMXPathで要素を検索した結果がnullになる場合があるため、必ずinstanceof DOMElementで有効な要素であるかを確認してから操作してください。