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

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

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

基本的な使い方

classNameプロパティは、Dom\Elementオブジェクトが表すHTML要素のclass属性の値を保持するプロパティです。PHPのDOM拡張機能を使用してHTMLやXML文書の要素をプログラムで操作する際に、このプロパティは特定の要素に適用されているCSSクラス名を取得したり、新しいCSSクラス名を設定したりするために利用されます。

ウェブページでは、class属性は要素の見た目をCSSで定義したり、JavaScriptによって要素を動的に操作するための識別子として頻繁に用いられます。たとえば、特定のデザインを適用したい要素に対してクラス名を読み書きすることで、スタイルの変更や動作の切り替えをPHPコードから直接制御できます。

もし要素に複数のクラス名が設定されている場合、それらのクラス名は「class1 class2 class3」のようにスペースで区切られた一つの文字列として扱われます。このプロパティに新しい値を設定する際には、既存のclass属性全体が指定した文字列で上書きされることに注意が必要です。Dom\Element::classNameプロパティは、PHPのDOM拡張機能を使ってウェブコンテンツの構造や表現を柔軟に操作する上で、非常に基本的ながらも重要な役割を果たす機能の一つです。

構文(syntax)


1<?php
2
3// Dom\Documentのインスタンスを作成
4$document = new Dom\Document();
5// div要素を作成
6$element = $document->createElement('div');
7
8// 要素のclass属性を設定する構文
9$element->className = 'my-class another-class';
10
11// 要素のclass属性を取得する構文
12$currentClasses = $element->className;
13
14// $currentClasses には 'my-class another-class' が文字列として格納されます
15?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このプロパティは、DOM要素のclass属性の値を文字列として返します。

サンプルコード

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


1<?php
2
3/**
4 * Dom\Element::className プロパティを使用して、
5 * HTML要素の 'class' 属性の値を文字列として取得するサンプルコードです。
6 *
7 * システムエンジニアを目指す初心者が、WebページのDOM（Document Object Model）を操作し、
8 * 特定の要素に設定されたクラス名を取得する方法を理解するのに役立ちます。
9 *
10 * @return void
11 */
12function demonstrateDomElementClassNameProperty(): void
13{
14    // 1. 解析するHTMLコンテンツを定義します。
15    //    'class' 属性を持つ<div>要素を含めます。
16    $htmlContent = <<<HTML
17    <!DOCTYPE html>
18    <html>
19    <head>
20        <title>Dom\Element::className のサンプル</title>
21    </head>
22    <body>
23        <div id="myTargetDiv" class="primary-container main-section">
24            <p>このdiv要素のクラス名を取得します。</p>
25        </div>
26        <span id="anotherTarget" class="highlighted">別の要素</span>
27    </body>
28    </html>
29    HTML;
30
31    // 2. DOMDocumentオブジェクトを作成し、HTMLコンテンツを読み込みます。
32    //    これにより、HTMLがPHPで操作可能なDOM構造に変換されます。
33    $dom = new DOMDocument();
34    $dom->loadHTML($htmlContent);
35
36    // 3. 特定のIDを持つHTML要素（Dom\Elementオブジェクト）を取得します。
37    //    ここではIDが 'myTargetDiv' の要素を探します。
38    $targetElement = $dom->getElementById('myTargetDiv');
39
40    // 4. 要素が正常に取得できたかを確認します。
41    //    PHP 8以降では、getElementById は \Dom\Element のインスタンスを返す可能性があります。
42    if ($targetElement instanceof \Dom\Element) {
43        // 5. Dom\Element::className プロパティを使用して、
44        //    要素の 'class' 属性の文字列値を取得し、表示します。
45        echo "ID 'myTargetDiv' を持つ要素のクラス名: " . $targetElement->className . PHP_EOL;
46    } else {
47        // 要素が見つからなかった場合のメッセージ
48        echo "ID 'myTargetDiv' を持つ要素が見つかりませんでした。" . PHP_EOL;
49    }
50
51    // 別の要素のクラス名も取得してみましょう。
52    $anotherElement = $dom->getElementById('anotherTarget');
53    if ($anotherElement instanceof \Dom\Element) {
54        echo "ID 'anotherTarget' を持つ要素のクラス名: " . $anotherElement->className . PHP_EOL;
55    } else {
56        echo "ID 'anotherTarget' を持つ要素が見つかりませんでした。" . PHP_EOL;
57    }
58}
59
60// サンプルコードを実行します。
61demonstrateDomElementClassNameProperty();
62

PHP 8で導入されたDom\Element::classNameプロパティは、WebページのHTML要素に設定されたclass属性の値を文字列として取得するために使用されます。システムエンジニアを目指す初心者の方にとって、Webアプリケーションで動的にHTML要素を操作する際の基本的な知識の一つとなります。

このプロパティは、Webページの内容をPHPで解析し、特定の要素がどのようなクラス名を持っているかを確認したい場合に特に役立ちます。例えば、特定のスタイルが適用されている要素を識別したり、JavaScriptで操作するための目印となるクラス名を取得したりする場面で利用できます。

サンプルコードでは、まず定義されたHTMLコンテンツをDOMDocumentオブジェクトに読み込むことで、HTMLの構造をPHPで扱えるDOM（Document Object Model）として構築しています。次に、getElementByIdメソッドを使って、IDが指定されたHTML要素（\Dom\Elementオブジェクト）を取得します。もし要素が正常に取得できた場合、その\Dom\ElementオブジェクトのclassNameプロパティにアクセスするだけで、その要素のclass属性の値、例えば「primary-container main-section」や「highlighted」といったクラス名を簡単に文字列として取得し、表示しています。

このclassNameプロパティは引数を必要とせず、常に要素のclass属性の値をそのまま文字列（string型）で返します。これにより、HTML要素のクラス情報を手軽に取得し、その後のプログラム処理に活用することが可能になります。DOM操作の第一歩として、このプロパティの利用方法を理解することは非常に重要です。

サンプルコードでは、HTML要素のクラス名を取得する際の注意点があります。$dom->getElementById()で要素を取得した後、その要素が本当に見つかったかを確認することが非常に重要です。取得結果がnullになる可能性があり、その状態でclassNameにアクセスするとエラーが発生しますので、instanceof \Dom\Elementによるチェックを必ず行ってください。また、対象のHTML要素にclass属性自体が存在しない場合、classNameプロパティは空の文字列を返します。これはエラーではありませんので、その挙動を理解しておく必要があります。classNameはクラス名を読み取るためのプロパティであり、変更する際には別のDOM操作メソッドを使用します。安全なDOM操作のため、要素の存在確認は常に意識してください。

PHP Dom\Element::className でクラス名を設定・取得する


1<?php
2
3/**
4 * この関数は、Dom\Element クラスの className プロパティの基本的な使い方を示します。
5 * className プロパティは、HTML要素の 'class' 属性の値を読み書きするために使用されます。
6 *
7 * システムエンジニアを目指す初心者向けに、各ステップにコメントを追加しています。
8 */
9function demonstrateDomElementClassName(): void
10{
11    // 1. HTML文字列を準備します。
12    //    ここでは、ID 'myDiv' といくつかのクラスを持つシンプルなdiv要素を作成します。
13    $htmlContent = '<div id="myDiv" class="initial-class another-class">Hello DOM!</div>';
14
15    // 2. Dom\Document オブジェクトを作成し、HTMLをロードします。
16    //    これはPHPでHTMLドキュメントを解析し、要素を操作するための最初のステップです。
17    $document = new Dom\Document();
18    $document->loadHTML($htmlContent);
19
20    // 3. ID 'myDiv' を持つ要素をドキュメントから取得します。
21    //    getElementById() メソッドは、指定されたIDの要素をDom\Elementオブジェクトとして返します。
22    $element = $document->getElementById('myDiv');
23
24    // 要素が見つからなかった場合のチェック（念のため）
25    if (!$element) {
26        echo "エラー: ID 'myDiv' を持つ要素が見つかりませんでした。\n";
27        return;
28    }
29
30    // 4. 現在の要素のクラス名を取得して表示します。
31    //    Dom\Element::className プロパティは、要素の 'class' 属性の現在の値（文字列）を返します。
32    echo "現在のクラス名: " . $element->className . "\n"; // 例: "initial-class another-class"
33
34    // 5. 要素のクラス名を新しい値に設定します。
35    //    className プロパティに新しい文字列を代入することで、要素の 'class' 属性を更新できます。
36    //    元のクラスはすべて上書きされ、指定した新しいクラスに置き換わります。
37    $element->className = "new-primary-class utility-class";
38    echo "クラス名を 'new-primary-class utility-class' に変更しました。\n";
39
40    // 6. 変更後のクラス名を取得して表示し、変更が適用されたことを確認します。
41    echo "変更後のクラス名: " . $element->className . "\n"; // 例: "new-primary-class utility-class"
42
43    // 7. 変更されたHTMLドキュメント全体を出力します。
44    //    これにより、要素の 'class' 属性が実際に更新されたことを確認できます。
45    echo "\n更新後のHTMLドキュメント:\n";
46    echo $document->saveHTML();
47}
48
49// 関数を実行して、Dom\Element::className の動作を確認します。
50demonstrateDomElementClassName();
51
52?>

PHP 8のDOM拡張機能に属するDom\Element::classNameプロパティは、HTML要素のclass属性の値を操作するために使用されます。このプロパティは引数を取らず、要素の現在のクラス名を示す文字列（string）を返します。

classNameプロパティを使用すると、HTMLドキュメント内の特定の要素が持つclass属性の値を簡単に取得したり、新しい値に設定したりできます。例えば、$element->classNameと記述することで、要素の現在のclass属性値がそのまま文字列として取得されます。この文字列には、複数のクラス名がスペースで区切られて含まれることがあります。

また、$element->className = "新しいクラス名";のように値を代入することで、要素のclass属性を更新できます。この際、元のclass属性に設定されていたすべてのクラス名は、指定した新しい文字列で完全に上書きされる点に注意が必要です。これにより、要素のスタイルや動作をプログラムから動的に変更することが可能になります。

サンプルコードでは、まずHTMLコンテンツを読み込み、特定のdiv要素を取得しています。次に、その要素の現在のクラス名を取得して表示し、その後classNameプロパティに新しい文字列を代入してクラス名を変更しています。最後に、変更後のクラス名と更新されたHTMLドキュメント全体を出力することで、classNameプロパティがHTMLのclass属性を直接的かつ効果的に操作できる様子を示しています。これは、ウェブアプリケーションで要素の外観や振る舞いを動的に制御する上で非常に重要な機能です。

このサンプルコードでclassNameプロパティに値を設定する際、要素に既に設定されている全てのクラスが新しい値で上書きされる点に注意が必要です。特定のクラスだけを追加・削除したい場合は、一度現在のclassNameプロパティの値を取得し、文字列操作で加工してから再度設定するか、より柔軟なDOM操作の方法を検討してください。このプロパティを使用する前には、Dom\DocumentにHTMLを正しくロードし、getElementByIdなどで操作対象のDom\Elementオブジェクトを確実に取得しておく必要があります。また、要素が見つからない場合に備えて、取得結果を常にチェックするエラーハンドリングを習慣にすると、より堅牢なコードになります。classNameは、複数のクラスがあっても単一のスペース区切り文字列として扱われることを理解しておきましょう。