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

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

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

基本的な使い方

doctypeプロパティは、Dom\Documentオブジェクトが表すHTMLやXMLドキュメントの「文書型宣言 (Document Type Declaration)」に関する情報を保持するプロパティです。文書型宣言とは、ドキュメントの種類や構造を定義する規則（DTD: Document Type Definition）を宣言するものであり、ウェブブラウザやXMLパーサーがドキュメントを正しく解釈するために重要な役割を果たします。

このプロパティにアクセスすることで、ドキュメントに記述されている<!DOCTYPE ...>という形式の宣言に関する情報を取得できます。具体的には、このプロパティはDom\DocumentTypeというオブジェクトを返します。このDom\DocumentTypeオブジェクトを通じて、文書型宣言の名前、公開識別子（PUBLIC ID）、システム識別子（SYSTEM ID）といった詳細な情報にアクセスすることが可能です。これにより、プログラム上でドキュメントがどのような形式のHTMLやXMLに準拠しているかを判断したり、その情報を利用した処理を行うことができます。

例えば、ドキュメントの適合性を確認したり、特定のDTDに依存する処理を分岐させたりする際に利用されます。もし対象のドキュメントに文書型宣言が存在しない場合、あるいはHTML5の<!DOCTYPE html>のように単純な宣言でDTDを参照しない場合は、このプロパティはnullを返します。これは、明示的なDTD情報が存在しないことを意味します。doctypeプロパティは読み取り専用であり、ドキュメントの文書型情報をプログラムから変更することはできません。

構文(syntax)


1<?php
2
3$domDocument = new \Dom\Document();
4$domDocumentType = $domDocument->doctype;
5
6?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?Dom\DocumentType

このプロパティは、現在のDOMドキュメントのDOCTYPE宣言を表すDom\DocumentTypeオブジェクト、またはDOCTYPE宣言が存在しない場合はnullを返します。

サンプルコード

PHP DOM doctype を定義・取得する


1<?php
2
3// 新しいDOMDocumentオブジェクトを作成します。
4$dom = new DOMDocument('1.0', 'UTF-8');
5
6// HTML文書構造を作成します。
7$dom->appendChild($dom->createElement('html'));
8
9// doctypeプロパティにアクセスします。
10$doctype = $dom->doctype;
11
12// doctypeが存在するか確認します。
13if ($doctype === null) {
14    echo "DOCTYPEは定義されていません。\n";
15
16    // HTML5のDOCTYPEを定義します。
17    $doctype = $dom->implementation->createDocumentType('html', '', '');
18    $dom->insertBefore($doctype, $dom->documentElement);
19
20    // 再度doctypeプロパティにアクセスします。
21    $doctype = $dom->doctype;
22
23    if ($doctype !== null) {
24        echo "DOCTYPEが定義されました。\n";
25    } else {
26        echo "DOCTYPEの定義に失敗しました。\n";
27    }
28} else {
29    echo "DOCTYPEは既に定義されています。\n";
30}
31
32// doctypeの名前を表示します（DOCTYPEが定義されている場合）。
33if ($doctype !== null) {
34    echo "DOCTYPE name: " . $doctype->name . "\n"; // 出力: html
35}
36
37// HTMLを文字列として出力します。
38$htmlString = $dom->saveHTML();
39echo $htmlString . "\n";
40// 出力例: <!DOCTYPE html>
41// <html></html>

このサンプルコードは、PHPのDom\Documentクラスのdoctypeプロパティを使用して、HTML文書のDOCTYPE（文書型定義）を操作する方法を示しています。

まず、DOMDocumentオブジェクトを作成し、HTML文書の基本的な構造（<html>要素）を追加します。doctypeプロパティは、文書に関連付けられたDom\DocumentTypeオブジェクトを返します。もしDOCTYPEが定義されていない場合、nullを返します。

サンプルコードでは、まずdoctypeプロパティにアクセスし、DOCTYPEが存在するかどうかを確認しています。DOCTYPEが存在しない場合、DOMImplementation::createDocumentType()メソッドを使ってHTML5のDOCTYPEを新たに作成し、insertBefore()メソッドでHTML要素の前に挿入します。

createDocumentType()メソッドは、指定された名前（この場合は'html'）、公開識別子、システム識別子を持つ新しいDom\DocumentTypeオブジェクトを作成します。insertBefore()メソッドは、指定されたノードを既存の子ノードの前に挿入します。

DOCTYPEを作成した後、再度doctypeプロパティにアクセスして、DOCTYPEが正常に定義されたことを確認します。DOCTYPEが定義されている場合、Dom\DocumentTypeオブジェクトのnameプロパティにアクセスして、DOCTYPEの名前（この場合は'html'）を表示します。

最後に、saveHTML()メソッドを使って、DOMドキュメントをHTML文字列として出力します。出力結果には、定義されたDOCTYPE宣言が含まれます。このコードを実行することで、HTML文書におけるDOCTYPEの重要性と、PHPでDOCTYPEを操作する方法を理解することができます。

DOMDocumentのdoctypeプロパティは、ドキュメントに関連付けられたDOCTYPEノードを表します。ドキュメントが作成された直後など、DOCTYPEが定義されていない場合はnullを返します。DOCTYPEを定義するには、DOMImplementation::createDocumentTypeメソッドを使用し、作成したノードをinsertBeforeメソッドでドキュメントのルート要素の前に追加する必要があります。saveHTMLでHTMLを出力する際に、定義したDOCTYPEが含まれることを確認しましょう。DOCTYPEの定義忘れは、ブラウザのレンダリングに影響を与える可能性があるため注意が必要です。

PHP DomDocument doctypeを取得・設定する


1<?php
2
3// 新しい DOMDocument オブジェクトを作成します。
4$dom = new DOMDocument('1.0', 'utf-8');
5
6// doctypeプロパティへのアクセス例
7$doctype = $dom->doctype;
8
9// doctypeが存在する場合、その名前を表示します。
10if ($doctype !== null) {
11    echo "Document Type Name: " . $doctype->name . PHP_EOL;
12} else {
13    echo "Document Type is not defined." . PHP_EOL;
14}
15
16// PDFを作成するためのDOCTYPEを設定する例
17$imp = new DOMImplementation();
18$dt = $imp->createDocumentType('html', '', ''); // html doctypeを例として使用。PDF固有のDOCTYPEはPDFライブラリに依存します。
19$dom = $imp->createDocument("", "html", $dt);
20
21// 設定後のdoctypeプロパティへのアクセス例
22$doctype = $dom->doctype;
23
24// doctypeが存在する場合、その名前を表示します。
25if ($doctype !== null) {
26    echo "Document Type Name: " . $doctype->name . PHP_EOL;
27} else {
28    echo "Document Type is not defined." . PHP_EOL;
29}
30
31?>

PHPのDom\Documentクラスにおけるdoctypeプロパティは、ドキュメントに関連付けられたDOCTYPEノードを取得するためのものです。DOCTYPEは、XMLやHTMLドキュメントの構造を定義するもので、例えばHTML5であれば<!DOCTYPE html>のような宣言です。

このプロパティは引数を持ちません。戻り値は?Dom\DocumentType型であり、DOCTYPEノードが存在する場合はそのノードオブジェクトを、存在しない場合はnullを返します。

サンプルコードでは、まず新しいDOMDocumentオブジェクトを作成し、doctypeプロパティにアクセスしています。初期状態ではDOCTYPEが定義されていないため、$dom->doctypeはnullを返します。

次に、DOMImplementationクラスを使用して新しいDOCTYPEノードを作成し、それをドキュメントに関連付けています。ここではHTMLのDOCTYPEを例として使用しています。PDFを作成する場合、一般的にはPDFライブラリが提供する機能を用いてPDFドキュメントを生成するため、DOCTYPEの設定は必須ではありません。しかし、XML形式でPDFの構造を定義するような特殊なケースでは、適切なDOCTYPEを設定する必要があるかもしれません。

DOCTYPEを設定後、再度doctypeプロパティにアクセスすると、今度はDOCTYPEノードオブジェクトが返され、そのnameプロパティ（DOCTYPEの名前）を表示しています。この例を通して、doctypeプロパティがDOCTYPEノードへのアクセス手段であり、その存在を確認し、情報を取得するために使用できることが理解できます。

Dom\Documentクラスのdoctypeプロパティは、ドキュメントのDOCTYPEノードを表します。DOCTYPEが定義されていない場合、nullを返します。

サンプルコードでは、まずDOCTYPEが存在しない状態でdoctypeプロパティにアクセスし、nullになることを確認しています。次に、DOMImplementationクラスを使ってDOCTYPEを明示的に設定しています。

PDFを作成する際は、PDF固有のDOCTYPEを設定する必要があります。ただし、標準のDom\DocumentクラスだけではPDFのDOCTYPEを直接設定することは難しいため、PDFライブラリの機能を利用することが一般的です。この例ではhtml doctypeを例として設定していますが、これはあくまで例であり、PDFとして有効なDOCTYPEではありません。doctypeプロパティへのアクセス前にDOCTYPEを設定することで、null以外の値を取得できることを示しています。