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

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

作成日: 2025年09月11日更新日: 2025年12月02日

基本的な使い方

firstChildプロパティは、Dom\DocumentTypeオブジェクトの最初の子ノードを保持するプロパティです。このプロパティは、PHPのDOM拡張機能の一部として提供されており、WebページやXMLファイルの構造を表すDOM（Document Object Model）ツリーをプログラムで操作する際に利用されます。

Dom\DocumentTypeクラスは、HTMLドキュメントにおける<!DOCTYPE html>宣言や、XMLドキュメントにおける<!DOCTYPE root-element ...>といった、ドキュメント型宣言を表すノードです。DOMツリーにおいて、firstChildプロパティは通常、あるノードの直下にある最初の子ノード、例えば最初の要素ノードやテキストノードなどを取得するために使用されます。

しかしながら、Dom\DocumentTypeノードの特性として、子ノードを持つことはありません。ドキュメント型宣言は、ドキュメント全体の構造やDTD（Document Type Definition）に関する情報を提供するものであり、それ自体が内部にさらに子要素を持つような構造ではないためです。

このため、Dom\DocumentTypeのインスタンスに対してfirstChildプロパティにアクセスすると、常にnullが返されます。これは、対象のDocumentTypeノードには子ノードが存在しないことを明示的に示しています。DOM操作を行う際には、このような特定のノードの特性を理解しておくことが重要です。

構文(syntax)


1<?php
2$dom = new DOMDocument();
3$dom->loadHTML('<!DOCTYPE html><html lang="en"><body></body></html>');
4
5$documentTypeNode = $dom->doctype;
6
7$firstChildOfDocumentType = $documentTypeNode->firstChild;
8?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

Dom\Node|null

このプロパティは、現在の Dom\DocumentType オブジェクトの最初の子ノードを返します。子ノードが存在しない場合は null を返します。

サンプルコード

PHP DOMDocument firstChild を取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMDocumentTypeのfirstChildプロパティの使用例を示します。
7 *
8 * DTD（文書型定義）に内部サブセット（エンティティ宣言など）が含まれている場合、
9 * それがDocumentTypeノードの子ノードとして扱われます。
10 * この関数は、XMLドキュメントからDocumentTypeノードを取得し、
11 * その最初の子ノードの情報を表示します。
12 */
13function displayDocumentTypeFirstChild(): void
14{
15    // DTD内に子ノード（この場合はエンティティ宣言）を持つXML文字列
16    // <!DOCTYPE note [...]> の角括弧内が内部サブセットであり、子ノードのコンテナとなります。
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<!DOCTYPE note [
20  <!ENTITY writer "Taro Yamada">
21  <!ENTITY company "PHP Corporation">
22]>
23<note>
24  <from>&writer;</from>
25</note>
26XML;
27
28    // DOMDocumentオブジェクトをインスタンス化
29    $dom = new DOMDocument();
30
31    // XML文字列を読み込む
32    $dom->loadXML($xmlString);
33
34    // DocumentTypeノード (<!DOCTYPE ...> に対応するオブジェクト) を取得
35    // このプロパティは DOMDocumentType または null を返します。
36    $docType = $dom->doctype;
37
38    if ($docType instanceof DOMDocumentType) {
39        echo 'DocumentType ノードが見つかりました: ' . $docType->nodeName . PHP_EOL;
40
41        // DocumentTypeの最初の子ノードを取得します。
42        // この例では、最初に宣言されたエンティティ <!ENTITY writer "Taro Yamada"> が
43        // DOMEntityノードとして取得されます。
44        $firstChild = $docType->firstChild;
45
46        if ($firstChild instanceof DOMNode) {
47            // 取得した子ノードの情報を表示
48            echo 'firstChild は DOMEntity オブジェクトです。' . PHP_EOL;
49            echo ' - ノード名 (nodeName): ' . $firstChild->nodeName . PHP_EOL;
50            echo ' - ノードタイプ (nodeType): ' . $firstChild->nodeType . ' (DOM_ENTITY_NODE)' . PHP_EOL;
51        } else {
52            echo 'DocumentType には子ノードが存在しません。' . PHP_EOL;
53        }
54    } else {
55        echo 'このドキュメントにはDocumentTypeノードが存在しません。' . PHP_EOL;
56    }
57}
58
59// 関数を実行して結果を表示
60displayDocumentTypeFirstChild();

DOMDocumentTypeクラスのfirstChildプロパティは、文書型定義（DTD）ノードが持つ最初の子ノードを取得するために使用します。XMLドキュメントにおいて、DTDの内部サブセット（<!DOCTYPE ... [...]>の角括弧で囲まれた部分）にエンティティ宣言などが記述されている場合、それらが子ノードとして扱われます。このプロパティに引数はありません。

サンプルコードでは、まず内部サブセットに2つのエンティティ宣言を持つXML文字列を用意します。次に、DOMDocumentオブジェクトを生成してXMLを読み込み、doctypeプロパティから文書型定義を表すDOMDocumentTypeオブジェクトを取得しています。

続いて、その$docTypeオブジェクトのfirstChildプロパティにアクセスすることで、DTD内の最初の子ノードを取得します。この例では、最初に定義されているエンティティ <!ENTITY writer "Taro Yamada"> が、DOMEntityオブジェクトとして返されます。最後に、取得したノードの情報を画面に出力して確認しています。

このプロパティの戻り値は、見つかった最初の子ノードを表すDOMNodeオブジェクトです。もし子ノードが存在しない場合はnullを返します。

DOMDocumentTypeのfirstChildプロパティは、DTDの内部サブセット、つまり<!DOCTYPE [...]>の角括弧内に記述された最初のノードを取得します。注意点として、XML文書にDTDが存在しない場合、$dom->doctypeプロパティ自体がnullになります。また、DTDがあっても内部サブセットが空であれば、firstChildプロパティもnullを返します。そのため、これらのプロパティにアクセスする際は、サンプルコードのようにinstanceofで型をチェックするか、nullでないことを必ず確認してください。このチェックを怠ると、オブジェクトが存在しない場合にエラーが発生する原因となります。

PHP DOM firstChildでDocumentTypeの子ノードを取得する


1<?php
2
3/**
4 * Dom\DocumentType の firstChild プロパティの使用例を示します。
5 *
6 * この関数は、内部DTD(Document Type Definition)を持つXML文字列をパースし、
7 * DOCTYPE宣言ノードの最初の子ノードを取得して、その情報を表示します。
8 */
9function demonstrateDocumentTypeFirstChild(): void
10{
11    // 内部DTDを持つXML文字列を定義します。
12    // <!DOCTYPE ...> の角括弧 [...] の部分が内部サブセットにあたり、
13    // この中の最初の宣言ノードが firstChild として取得されます。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<!DOCTYPE note [
17  <!ENTITY writer "John Doe">
18  <!ENTITY company "ACME Corp.">
19]>
20<note>
21  <content>Sample content</content>
22</note>
23XML;
24
25    // DOMDocumentオブジェクトをインスタンス化します。
26    $dom = new \DOMDocument();
27
28    // XML文字列を読み込みます。
29    $dom->loadXML($xmlString);
30
31    // DocumentTypeノード (<!DOCTYPE ...> に対応するオブジェクト) を取得します。
32    // このプロパティは Dom\DocumentType | null 型です。
33    $docType = $dom->doctype;
34
35    // DocumentTypeノードが存在するか確認します。
36    if ($docType instanceof \DOMDocumentType) {
37        echo "DocumentTypeノードが見つかりました: " . $docType->nodeName . "\n";
38
39        // DocumentTypeノードの最初の子ノードを取得します。
40        // この例では、内部DTDの最初のエンティティ宣言 <!ENTITY writer ...> が
41        // DOMEntityノードとして取得されます。
42        $firstChild = $docType->firstChild;
43
44        if ($firstChild instanceof \DOMNode) {
45            echo "DocumentTypeのfirstChildが見つかりました。\n";
46            // DOMEntityノードの場合、nodeNameはエンティティ名 'writer' になります。
47            echo " -> firstChildのノード名: " . $firstChild->nodeName . "\n";
48            // ノードの種類（DOM_ENTITY_NODE は 6）
49            echo " -> firstChildのノードタイプ: " . $firstChild->nodeType . " (DOM_ENTITY_NODE)\n";
50        } else {
51            // 単純な <!DOCTYPE html> のようなDOCTYPE宣言には子ノードがないため、
52            // その場合 firstChild は null になります。
53            echo "DocumentTypeに子ノードはありません (firstChild is null)。\n";
54        }
55    } else {
56        echo "DocumentTypeノードが見つかりませんでした。\n";
57    }
58}
59
60// 関数を実行して結果を表示します。
61demonstrateDocumentTypeFirstChild();

Dom\DocumentTypeクラスのfirstChildプロパティは、XML文書の文書型宣言（DOCTYPE）が持つ内部サブセット内の、最初の子ノードを取得するために使用されます。内部サブセットとは、<!DOCTYPE ... [...]>の角括弧[]で囲まれた部分のことで、エンティティ宣言などが含まれます。

サンプルコードでは、まず<!ENTITY writer "John Doe">というエンティティ宣言を含む内部サブセットを持つXML文字列を定義しています。DOMDocumentクラスでこのXMLを読み込み、doctypeプロパティからDom\DocumentTypeオブジェクトを取得します。次に、このオブジェクトのfirstChildプロパティにアクセスすることで、内部サブセットの最初の子ノードを取得します。この例では、最初のエンティティ宣言がDOMEntityオブジェクトとして返され、そのノード名（nodeName）はエンティティ名である「writer」となります。

このプロパティに引数はありません。戻り値は、子ノードが存在すればそのノードを表すDom\Nodeオブジェクト、存在しなければnullとなります。例えば、<!DOCTYPE html>のように内部サブセットを持たない文書型宣言の場合、firstChildはnullを返します。これにより、DOCTYPE宣言の内部構造をプログラムで解析できます。

Dom\DocumentTypeのfirstChildプロパティは、DOCTYPE宣言の角括弧[]で囲まれた内部DTDサブセット内にある、最初の宣言ノードを取得します。サンプルコードでは、最初のエンティティ宣言がこれに該当します。最も重要な注意点は、このプロパティがnullを返す可能性があることです。内部DTDサブセットが存在しない場合（例: <!DOCTYPE html>）、firstChildはnullになります。そのため、プロパティの値を利用する前には、サンプルコードのようにif文などで必ずnullでないことを確認してください。このチェックを怠ると、オブジェクトがないのにアクセスしようとしてエラーが発生する原因となります。また、このプロパティは値を取得するための読み取り専用であり、値を代入することはできません。