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

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

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

基本的な使い方

toggleAttributeメソッドは、DOM要素の属性の存在を切り替えるメソッドです。具体的には、指定された名前の属性が存在する場合、その属性を削除します。存在しない場合は、指定された値を持つ属性を追加します。このメソッドは、DOMElementクラスに属しており、要素の属性を動的に制御するために使用されます。

属性の切り替えは、主にHTML要素の特定の状態を表すために利用されます。例えば、チェックボックスのオン/オフや、メニューの開閉状態などを属性として管理する場合に、このメソッドが役立ちます。属性の存在と非存在で状態を表現することで、JavaScriptなどから要素の状態を容易に判別できるようになります。

メソッドの引数には、切り替えたい属性の名前（文字列）と、属性が存在しない場合に設定する値（文字列）を指定します。属性名のみを指定した場合、存在しない場合は空文字列が設定されます。属性が存在する場合は削除されるため、値は無視されます。

このメソッドは、DOM操作の一環として、Webページの動的な変更を実現するために重要な役割を果たします。要素の属性を操作することで、ユーザーインタラクションに応じた視覚的な変化や、要素の動作を制御することが可能になります。また、HTMLの構造をプログラムから操作することで、Webアプリケーションの柔軟性と応答性を高めることができます。toggleAttributeメソッドは、このような動的なWebページやアプリケーションの開発において、非常に便利なツールとなります。

構文(syntax)


1DOMElement::toggleAttribute(string $name, bool $force = false): bool

引数(parameters)

string $qualifiedName, ?bool $force = null

string $qualifiedName: トグルしたい属性の名前を指定する文字列
?bool $force = null: 属性を削除したい場合は false を、追加または更新したい場合は true を指定します。null の場合は、属性が存在すれば削除し、存在しなければ追加します。

戻り値(return)

bool

指定された属性の存在を切り替えます。属性が存在しない場合は追加され、存在する場合は削除されます。成功した場合はtrue、失敗した場合はfalseを返します。

サンプルコード

PHP DOMElement::toggleAttributeで属性を操作する


1<?php
2
3// DOMDocument を作成し、出力整形を有効にします。
4// これにより、生成されるHTMLが見やすくなります。
5$dom = new DOMDocument('1.0', 'UTF-8');
6$dom->formatOutput = true;
7
8// HTML要素 (ここではシンプルな div 要素) を作成し、DOMツリーに追加します。
9// toggleAttribute メソッドは DOMElement のメソッドなので、操作対象の要素が必要です。
10$div = $dom->createElement('div');
11$div->setAttribute('id', 'exampleDiv'); // 識別用にID属性を追加
12$dom->appendChild($div);
13
14echo "--- 初期状態 ---" . PHP_EOL;
15// 現在のDOMのHTMLを出力して、初期状態を確認します。
16echo $dom->saveHTML();
17echo PHP_EOL;
18
19// 1. 'data-enabled' 属性が存在しない状態で toggleAttribute を呼び出す
20//    第2引数 (force) を省略すると、属性が存在しなければ追加されます。
21echo "--- 1. 'data-enabled' 属性を追加 (存在しないため) ---" . PHP_EOL;
22$isToggled = $div->toggleAttribute('data-enabled');
23// toggleAttribute の戻り値は、実際に属性が変更された場合に true を返します。
24echo "toggleAttribute の戻り値: " . ($isToggled ? 'true' : 'false') . PHP_EOL;
25echo $dom->saveHTML();
26echo PHP_EOL;
27
28// 2. 'data-enabled' 属性が存在する状態で toggleAttribute を呼び出す
29//    第2引数 (force) を省略すると、属性が存在すれば削除されます。
30echo "--- 2. 'data-enabled' 属性を削除 (存在するため) ---" . PHP_EOL;
31$isToggled = $div->toggleAttribute('data-enabled');
32echo "toggleAttribute の戻り値: " . ($isToggled ? 'true' : 'false') . PHP_EOL;
33echo $dom->saveHTML();
34echo PHP_EOL;
35
36// 3. 'data-active' 属性を force=true で追加する
37//    第2引数に true を指定すると、属性の有無に関わらず、強制的に属性を追加します。
38//    すでに属性が存在していても、追加は試みられますが、DOMの変更がないため false を返すことがあります。
39echo "--- 3. 'data-active' 属性を強制追加 ---" . PHP_EOL;
40$isToggled = $div->toggleAttribute('data-active', true);
41echo "toggleAttribute の戻り値: " . ($isToggled ? 'true' : 'false') . PHP_EOL;
42echo $dom->saveHTML();
43echo PHP_EOL;
44
45// 4. 'data-active' 属性を force=false で削除する
46//    第2引数に false を指定すると、属性の有無に関わらず、強制的に属性を削除します。
47echo "--- 4. 'data-active' 属性を強制削除 ---" . PHP_EOL;
48$isToggled = $div->toggleAttribute('data-active', false);
49echo "toggleAttribute の戻り値: " . ($isToggled ? 'true' : 'false') . PHP_EOL;
50echo $dom->saveHTML();
51echo PHP_EOL;
52
53// 5. 存在しない 'data-status' 属性を force=false で削除しようと試みる
54//    属性が存在しないため何も変更されず、false を返します。
55echo "--- 5. 存在しない 'data-status' 属性を強制削除しようと試みる ---" . PHP_EOL;
56$isToggled = $div->toggleAttribute('data-status', false);
57echo "toggleAttribute の戻り値: " . ($isToggled ? 'true' : 'false') . PHP_EOL;
58echo $dom->saveHTML();
59echo PHP_EOL;
60
61?>

PHPのDOMElement::toggleAttributeメソッドは、HTMLなどのDOM要素に設定された属性を動的に操作する際に使用します。このメソッドは、指定された$qualifiedName（属性名）の属性を切り替えたり、強制的に追加・削除したりする機能を提供します。

第2引数$forceを省略するかnullにすると、属性が存在しない場合は追加し、存在する場合は削除するという「トグル（切り替え）」動作を行います。この場合、属性が実際に変更されれば戻り値はtrueです。

$forceにtrueを指定すると属性を強制的に追加し、falseを指定すると属性を強制的に削除します。戻り値は、属性の操作によってDOMに実際の変更が発生した場合にのみtrueを返し、変更がなければfalseとなります。

提供されたサンプルコードは、div要素に対してtoggleAttributeメソッドを様々な引数で適用し、属性の追加・削除の具体的な挙動と、その際のtrue/falseの戻り値を確認できます。これにより、DOM要素の属性を効率的に制御する方法を学ぶことができます。

toggleAttributeメソッドは、指定したHTML要素の属性の有無を切り替える際に使用します。第2引数$forceを省略すると、属性が存在しない場合は追加し、存在する場合は削除する通常のトグル動作をします。$forceにtrueを指定すると強制的に属性を追加し、falseを指定すると強制的に属性を削除します。特に注意すべきは、戻り値のbool型です。属性の状態が実際に変化した場合にのみtrueを返します。例えば、$force=trueで既に属性が存在していた場合や、$force=falseで属性が元々存在しなかった場合など、DOMに変更がなければfalseが返されるため、戻り値の解釈には注意が必要です。この挙動を理解することで、意図しない属性の操作を防ぎ、コードを安全に利用できます。

DOMElement::toggleAttributeで属性をトグルする


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMElement::toggleAttribute の使用例。
7 * 特定の HTML 要素の属性をトグル（追加・削除）する関数です。
8 * これは、JavaScript (jQuery) で要素のクラスをトグルしたり、
9 * 属性を有効/無効に切り替える操作 (例: `$(selector).prop('disabled', !$(selector).prop('disabled'))`)
10 * に相当するサーバーサイドの機能です。
11 */
12function demonstrateDOMToggleAttribute(): void
13{
14    // 新しい DOM ドキュメントを作成します。
15    // ここでHTML構造を構築し、属性を操作します。
16    $dom = new DOMDocument('1.0', 'UTF-8');
17    $dom->formatOutput = true; // 出力時に整形されるように設定
18
19    // HTMLの基本構造（<body>タグ内にボタンを配置）
20    $html = $dom->createElement('html');
21    $body = $dom->createElement('body');
22    $html->appendChild($body);
23    $dom->appendChild($html);
24
25    // デモンストレーション用のボタン要素を作成します。
26    $button = $dom->createElement('button', 'クリックしてね');
27    $button->setAttribute('id', 'myButton');
28    $body->appendChild($button);
29
30    echo "--- 初期状態 ---\n";
31    echo "ボタンの disabled 属性: " . ($button->hasAttribute('disabled') ? 'あり' : 'なし') . "\n";
32    echo $dom->saveHTML() . "\n\n";
33
34    // 1. `disabled` 属性をトグルします。
35    // ボタンにはまだ `disabled` 属性がないため、この呼び出しで属性が追加されます。
36    // 戻り値は属性が現在存在するかどうかを示します。
37    echo "--- 1. 'disabled' 属性をトグル (初回) ---\n";
38    $isNowDisabled = $button->toggleAttribute('disabled');
39    echo "'disabled' 属性が現在存在しますか？ " . ($isNowDisabled ? 'はい' : 'いいえ') . "\n";
40    echo $dom->saveHTML() . "\n\n";
41
42    // 2. 再び `disabled` 属性をトグルします。
43    // ボタンには既に `disabled` 属性があるため、この呼び出しで属性が削除されます。
44    echo "--- 2. 'disabled' 属性をトグル (2回目) ---\n";
45    $isNowDisabled = $button->toggleAttribute('disabled');
46    echo "'disabled' 属性が現在存在しますか？ " . ($isNowDisabled ? 'はい' : 'いいえ') . "\n";
47    echo $dom->saveHTML() . "\n\n";
48
49    // 3. `data-active` 属性を強制的に追加します (`$force = true`)。
50    // 属性が存在しない場合でも、常に存在するようになります。
51    echo "--- 3. 'data-active' 属性を強制的に追加 (force = true) ---\n";
52    $isNowActive = $button->toggleAttribute('data-active', true);
53    echo "'data-active' 属性が現在存在しますか？ " . ($isNowActive ? 'はい' : 'いいえ') . "\n";
54    echo $dom->saveHTML() . "\n\n";
55
56    // 4. `data-active` 属性を強制的に削除します (`$force = false`)。
57    // 属性が存在する場合でも、常に削除されます。
58    echo "--- 4. 'data-active' 属性を強制的に削除 (force = false) ---\n";
59    $isNowActive = $button->toggleAttribute('data-active', false);
60    echo "'data-active' 属性が現在存在しますか？ " . ($isNowActive ? 'はい' : 'いいえ') . "\n";
61    echo $dom->saveHTML() . "\n\n";
62}
63
64// 関数を実行して、DOMElement::toggleAttribute の動作を確認します。
65demonstrateDOMToggleAttribute();

DOMElement::toggleAttribute は、PHPでHTML要素の属性（例: disabled や data-active など）をサーバーサイドで効率的に管理するためのメソッドです。これは、ウェブブラウザ上でJavaScript（jQueryなど）を使って、要素のクラスをトグルしたり、属性を有効/無効に切り替えたりする操作に相当する機能を提供します。

このメソッドは、指定された属性が要素に存在しない場合は追加し、既に存在する場合は削除するという「トグル」動作を行います。引数 string $qualifiedName には、操作したい属性の名前を指定します。例えば、「disabled」という属性名を与えると、ボタンが無効状態になったり、有効状態に戻ったりします。

オプションの引数 ?bool $force = null を使用すると、トグル動作を強制できます。$force に true を指定すると、属性が存在するかどうかにかかわらず常に属性を追加します。逆に false を指定すると、常に属性を削除します。この引数を省略するか null にすると、通常のトグル動作、つまり属性の有無に応じて追加・削除が切り替わります。

メソッドの戻り値は bool 型で、このメソッドの実行後に指定された属性が要素に存在するかどうかを示します。

サンプルコードでは、まずボタン要素を作成し、初期状態から disabled 属性の追加と削除のトグル動作を確認しています。その後、data-active 属性に対して $force 引数を true と false に設定し、強制的に属性を追加したり削除したりする挙動を具体的に示しています。これにより、PHPを使って動的にHTMLの属性状態を制御する方法を理解できます。

DOMElement::toggleAttributeは、PHPのサーバーサイドでHTML要素の属性を操作するメソッドです。これはJavaScriptのようにブラウザで動的に変更するのではなく、PHPスクリプト実行時にHTML構造を構築する目的で使用される点を理解してください。

第二引数$forceは、属性の有無を強制的に指定する際に利用します。trueで常に属性を追加し、falseで常に属性を削除し、省略またはnullの場合は現在の状態に応じてトグルします。この挙動を混同しないよう注意が必要です。

戻り値は、操作後にその属性が最終的に存在するかどうかを示します。操作の成功・失敗とは異なるため、戻り値の意味を正しく把握することが重要です。このメソッドで構築されたDOMは、DOMDocument::saveHTML()などで最終的なHTMLとして出力されます。