【PHP8.x】classListプロパティの使い方

classListプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

classListプロパティは、DOM要素のクラス属性(class attribute)を操作するためのDOMTokenListオブジェクトを保持するプロパティです。Dom\HTMLElementクラスに属し、PHPのDOM拡張モジュールで使用されます。

具体的には、HTML要素のclass属性に設定されているクラス名の一覧を、DOMTokenListオブジェクトとして取得・変更するために利用します。DOMTokenListオブジェクトは、スペースで区切られたクラス名の集合を配列のように扱える便利なインターフェースを提供します。

classListプロパティを使用することで、要素に特定のクラスを追加したり、削除したり、存在を確認したりといった操作を簡単に行うことができます。例えば、要素に特定のスタイルを適用するためにクラスを追加したり、ある条件に応じてクラスを切り替えたりする場合に有効です。

このプロパティは読み取り専用であり、直接新しいDOMTokenListオブジェクトを割り当てることはできません。classListプロパティを通じて取得したDOMTokenListオブジェクトのメソッド(add、remove、toggle、containsなど)を使用して、クラスリストを操作します。

Dom\HTMLElementオブジェクトのclassListプロパティにアクセスすることで、対応するHTML要素のクラス属性をプログラムから動的に操作し、Webページの表示や動作を制御できます。JavaScriptにおけるclassListプロパティと同様の機能を提供し、PHPでサーバーサイドのHTML処理を行う際に役立ちます。

構文(syntax)

1<?php
2
3$element = new Dom\HTMLElement();
4$classList = $element->classList;
5
6?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DOMTokenList

Dom\HTMLElement クラスの classList プロパティは、要素に適用されている CSS クラスのリストを管理するための DOMTokenList オブジェクトを返します。このオブジェクトを通じて、クラスの追加、削除、切り替え、および存在確認を行うことができます。