【PHP8.x】Dom\HTMLElement::classNameプロパティの使い方

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

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

基本的な使い方

classNameプロパティは、Dom\HTMLElementクラスの要素に設定されているクラス属性の値を保持するプロパティです。具体的には、HTML要素のclass属性に指定された文字列を、このプロパティを通じて取得したり、設定したりすることができます。

このプロパティを利用することで、JavaScriptなどのクライアントサイドのスクリプトを使用せずに、PHP側でHTML要素のクラスを操作することが可能になります。例えば、特定の条件に応じて要素のクラスを追加・削除したり、要素のクラスに基づいて処理を分岐させたりといったことが実現できます。

classNameプロパティへのアクセスは、オブジェクト指向プログラミングの原則に従い、Dom\HTMLElementオブジェクトのインスタンスを通して行います。プロパティに値を設定する際には、文字列としてクラス名を指定します。複数のクラスを設定する場合は、空白で区切って指定します。値を読み出す際には、設定されているクラス名が空白区切りの文字列として返されます。

このプロパティは、HTMLドキュメントをPHPで解析し、動的にHTMLコンテンツを生成する際に非常に役立ちます。例えば、データベースの内容に基づいて、特定の条件を満たす要素に特定のクラスを付与するといった処理を自動化することができます。

classNameプロパティを使用する際には、意図しないクラスの変更や削除に注意する必要があります。既存のクラスを保持しつつ、新しいクラスを追加する場合には、現在のclassNameプロパティの値を取得し、新しいクラスを追記するなどの工夫が必要です。適切に使用することで、動的で柔軟なウェブアプリケーションの開発を支援します。

構文(syntax)


1<?php
2
3// Dom\HTMLDocument のインスタンスを作成
4$document = new Dom\HTMLDocument();
5
6// 新しい HTML 要素（例: div）を作成し、Dom\HTMLElement オブジェクトとして取得
7$element = $document->createElement('div');
8
9// className プロパティに文字列を設定する（HTML要素のclass属性を設定）
10$element->className = 'my-class active-state';
11
12// className プロパティから文字列を取得する（HTML要素のclass属性の値を取得）
13$currentClassName = $element->className;
14
15?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

Dom\HTMLElement クラスの className プロパティは、要素に現在設定されている CSS クラス名の文字列を返します。

サンプルコード

PHP Dom\HTMLElement::className でクラス名を取得する


1<?php
2
3// Dom\HTMLElement クラスの className プロパティを使用して、要素のクラス名を取得する例
4$dom = new DOMDocument();
5$dom->loadHTML('<!DOCTYPE html><html><body><div class="my-class another-class">Hello</div></body></html>');
6
7// div 要素を取得
8$element = $dom->getElementsByTagName('div')->item(0);
9
10// className プロパティを使用してクラス名を取得
11if ($element instanceof DOMElement) {
12    $className = $element->getAttribute('class');
13
14    echo "Element's class name: " . $className . PHP_EOL;
15} else {
16    echo "Element not found or is not a DOMElement." . PHP_EOL;
17}
18
19?>

PHPのDom\HTMLElementクラスにおけるclassNameプロパティは、HTML要素のclass属性の値を取得するために使用します。このプロパティはPHP 8で利用可能です。

上記のサンプルコードでは、まずDOMDocumentオブジェクトを作成し、HTML文字列をロードしています。次に、getElementsByTagNameメソッドを使用して、div要素を取得します。item(0)で最初のdiv要素を取得し、$element変数に格納します。

取得した要素がDOMElementのインスタンスであるかどうかをinstanceof演算子で確認します。DOMElementである場合、getAttribute('class')メソッドを使用して、class属性の値を取得し、$className変数に格納します。getAttribute('class')は、属性値を文字列として返します。

最後に、取得したクラス名をechoステートメントで出力します。もし要素が見つからないか、DOMElementでない場合は、エラーメッセージを出力します。

classNameプロパティ（getAttribute('class')）を使用することで、HTML要素に設定されたクラス名を簡単に取得し、PHPで処理することができます。例えば、特定のクラスを持つ要素を検索したり、クラス名に基づいて処理を分岐したりする際に役立ちます。戻り値は文字列型で、要素が持つクラス名の値を返します。

Dom\HTMLElement クラスの className プロパティは、要素のクラス名を取得するために使用されます。このサンプルコードでは、まずHTMLドキュメントを読み込み、getElementsByTagName で特定の要素を取得しています。getAttribute('class') でクラス名を取得している点に注意してください。HTMLElement クラスの className プロパティを直接参照する方法もありますが、getAttribute('class') の方が一般的です。要素が存在しない場合や、取得した要素が DOMElement のインスタンスでない場合はエラーが発生する可能性があるため、if文で事前に確認することが重要です。また、取得されるクラス名は文字列であるため、文字列操作関数を利用して、加工や検証を行うこともできます。

PHP DomHTMLElementのclassNameを取得する


1<?php
2
3// Dom\HTMLElement クラスの className プロパティを使用して、要素のクラス名を取得する例
4$dom = new DOMDocument();
5$dom->loadHTML('<html><body><div class="my-class another-class">Hello</div></body></html>');
6
7$element = $dom->getElementsByTagName('div')->item(0);
8
9if ($element instanceof DOMElement) {
10  $className = $element->getAttribute('class'); // または $element->className;
11
12  echo "クラス名: " . $className . PHP_EOL; // 結果: my-class another-class
13}

PHPのDom\HTMLElementクラスにおけるclassNameプロパティは、HTML要素のclass属性の値を取得するために使用されます。このプロパティは、引数を必要とせず、文字列型の値を返します。

上記のサンプルコードでは、まずDOMDocumentクラスを使用してHTMLドキュメントを読み込んでいます。次に、getElementsByTagNameメソッドでdiv要素を取得し、その要素がDOMElementのインスタンスであるかを確認しています。

DOMElementのインスタンスであれば、classNameプロパティにアクセスすることで、div要素に設定されているclass属性の値（ここではmy-class another-class）を変数$classNameに取得できます。

サンプルコードでは、$element->getAttribute('class')を使用していますが、これは$element->classNameと等価です。どちらの方法でも同じ結果を得られます。最後に、取得したクラス名をecho文で出力しています。この例では、div要素が複数のクラスを持つため、スペースで区切られた文字列としてクラス名が出力されます。classNameプロパティを使用することで、HTML要素のスタイル設定やJavaScriptによる操作に必要なクラス名を簡単に取得できます。

Dom\HTMLElement クラスの className プロパティは、要素のクラス名を取得します。しかし、直接 className プロパティにアクセスする代わりに、getAttribute('class') メソッドを使用する方法が一般的です。これは、DOMElement が Dom\HTMLElement を継承しているためです。

要素が存在しない場合、getElementsByTagName() は空の DOMNodeList を返すため、item(0) が null になる可能性があります。そのため、$element が DOMElement のインスタンスであることを instanceof で確認してからクラス名を取得するようにしてください。

PHP 8 以降では、null許容型が導入されているため、item(0) が null を返す可能性を考慮した方が安全です。$className を使用する前に、$element が null でないことを確認することをお勧めします。