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

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

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

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

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

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

string $qualifiedName, ?bool $force = null

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

bool

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