【PHP8.x】Dom\HTMLDocument::createEmpty()メソッドの使い方

createEmptyメソッドの使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

createEmptyメソッドは、Dom\HTMLDocumentクラスに属し、新しい空のHTMLドキュメントオブジェクトを生成して返却するメソッドです。このメソッドは、HTMLの基本的な構造、例えば<!DOCTYPE html><html><head></head><body></body></html>といった最小限のマークアップを持つ、完全に新しいHTMLドキュメントインスタンスを作成します。既存のHTMLコンテンツを解析して読み込むのではなく、全く何もない状態からHTMLドキュメントをプログラム的に構築したい場合に利用されます。

システム内で動的にHTMLコンテンツを生成する際、このメソッドによって得られる空のドキュメントは、その後のHTML要素の追加や変更といったDOM操作を始める上での土台となります。例えば、Webアプリケーションでユーザーの入力に基づいてカスタマイズされたHTMLページを生成する場合や、特定のレポートをHTML形式で出力する際に、初期状態のドキュメントとして非常に有効です。

このメソッドは引数を一切取りません。呼び出すと、新しく生成されたDom\HTMLDocumentオブジェクトが戻り値として提供されます。この戻り値のオブジェクトは、HTMLドキュメントのルートを表し、その後にappendChildやcreateElementといったDOM操作メソッドを用いて要素を追加したり、属性を設定したりすることで、具体的なHTML構造を自由に構築していくことが可能です。HTMLドキュメントを扱うPHPアプリケーションにおいて、プログラム的にHTMLをゼロから組み立てる際の出発点として、本メソッドは重要な役割を果たします。

構文(syntax)


1<?php
2
3$document = Dom\HTMLDocument::createEmpty();

引数(parameters)

string $encoding = 'UTF-8'

string $encoding = 'UTF-8': 作成するHTMLドキュメントのエンコーディングを指定する文字列。デフォルトは 'UTF-8' です。

戻り値(return)

Dom\HTMLDocument

このメソッドは、新しく空のHTMLドキュメントオブジェクトを生成し、そのオブジェクトを返します。

サンプルコード

Dom\HTMLDocument::createEmpty()で空のHTMLドキュメントを作成する


1<?php
2
3/**
4 * Dom\HTMLDocument::createEmpty() メソッドの使用例を示します。
5 *
6 * このメソッドは、新しい空のHTMLドキュメントオブジェクトを作成します。
7 * HTMLコンテンツをPHPでゼロから構築する際の出発点として利用されます。
8 */
9function createEmptyHtmlDocumentExample(): void
10{
11    echo "Dom\\HTMLDocument::createEmpty() の使用例:\n";
12    echo "-------------------------------------------\n";
13
14    // Dom\HTMLDocument::createEmpty() を呼び出し、新しい空のHTMLドキュメントを作成します。
15    // デフォルトのエンコーディングは 'UTF-8' です。
16    // このドキュメントは、最小限のHTML5構造を持ちますが、具体的なコンテンツ（要素やテキスト）は含まれていません。
17    $document = Dom\HTMLDocument::createEmpty();
18
19    echo "生成されたドキュメントのクラス: " . get_class($document) . "\n";
20
21    // ドキュメントの内容をHTML文字列として出力します。
22    // 初期状態では、コンテンツ部分は「空白」であることが確認できます。
23    echo "\n生成されたHTMLドキュメントの内容 (saveHTML()):\n";
24    echo "```html\n" . $document->saveHTML() . "```\n";
25    echo "\nこのドキュメントは、HTMLコンテンツをこれから追加していくための「空の器」となります。\n";
26}
27
28// サンプル関数を実行します。
29createEmptyHtmlDocumentExample();
30

PHP 8のDom\HTMLDocument::createEmpty()メソッドは、新しい空のHTMLドキュメントオブジェクトを作成するために使用されます。このメソッドは、ウェブページなどのHTMLコンテンツをPHPプログラム内でゼロから構築する際の、出発点となる「空白の器」を提供します。

引数としてstring $encodingを受け取ります。これはドキュメントの文字エンコーディングを指定するためのもので、省略した場合はデフォルトで'UTF-8'が適用されます。このエンコーディングは、作成されるHTMLドキュメントの<meta charset="...">タグにも反映されます。戻り値は、新しく生成されたDom\HTMLDocumentオブジェクトそのものであり、これに対してHTML要素を追加したり、内容を操作したりすることができます。

サンプルコードでは、Dom\HTMLDocument::createEmpty()を呼び出して$document変数に格納しています。生成された$documentオブジェクトは、HTML5の基本構造（<!DOCTYPE html>, <html>, <head>, <body>など）は持ちますが、<body>タグの中身は一切含まれていません。saveHTML()メソッドでその内容を出力すると、初期状態ではコンテンツ部分が「空白」であることが確認できます。これは、これからappendChild()などのメソッドを使って、HTML要素をプログラム的に追加していく準備が整っていることを意味します。このように、このメソッドはプログラムで動的にHTMLを生成する際の基礎となります。

Dom\HTMLDocument::createEmpty()は、完全に「空の文字列」を生成するわけではありません。<!DOCTYPE html>などの基本的なHTML5構造を持つ、内容が空の新しいHTMLドキュメントオブジェクトを作成します。これは、これからPHPでHTMLコンテンツを構築するための「空の器」として機能します。メソッド実行直後のドキュメントには具体的な要素やテキストは含まれていませんので、必要に応じて後から要素を追加していく必要があります。引数でエンコーディングを指定しない場合、デフォルトでUTF-8が適用されます。異なる文字コードのHTMLを作成する場合は、引数を明示的に指定してください。

PHP Dom\HTMLDocument::createEmpty() で空のHTMLドキュメントを作成する


1<?php
2
3// Dom\HTMLDocument::createEmpty() メソッドは、新しい空のHTML5ドキュメントを作成します。
4// このメソッドは、HTMLドキュメントをゼロから構築し始める際に利用されます。
5
6// 引数を指定しない場合、デフォルトで 'UTF-8' エンコーディングのドキュメントが作成されます。
7// これは、HTML5の基本構造（<!DOCTYPE html><html><head></head><body></body></html>）を持ちますが、
8// body要素の中には何もコンテンツが含まれていない「空」の状態です。
9$htmlDocument = Dom\HTMLDocument::createEmpty();
10
11// 生成されたドキュメントの内容を確認します。
12// saveHTML() メソッドは、ドキュメント全体のHTML文字列を返します。
13echo "Dom\\HTMLDocument::createEmpty() で作成された空のHTMLドキュメントの内容:" . PHP_EOL;
14echo "--------------------------------------------------------------------" . PHP_EOL;
15echo $htmlDocument->saveHTML();
16echo "--------------------------------------------------------------------" . PHP_EOL;
17
18// このように、createEmpty() は「空白」または「内容が空の」状態のHTMLドキュメントを生成し、
19// その後で要素を追加していく準備ができた状態を提供します。
20
21?>

Dom\HTMLDocument::createEmpty() メソッドは、PHPで新しい空のHTML5ドキュメントを作成するためのクラスメソッドです。これは、プログラムでウェブページをゼロから生成したり、HTMLコンテンツを操作したりする際に、初期状態のHTMLドキュメントを準備する場合に利用されます。

このメソッドは、$encoding という文字列型の引数を取ります。これはドキュメントの文字エンコーディングを指定するもので、省略した場合はデフォルトで 'UTF-8' が適用されます。通常は特別な設定が不要なため、引数を指定せずに利用することが一般的です。

メソッドが実行されると、新しく生成された Dom\HTMLDocument オブジェクトが返されます。このオブジェクトは、HTML5の標準的な基本構造である <!DOCTYPE html><html><head></head><body></body></html> を備えていますが、<body> 要素の中にはまだ何のコンテンツも含まれていない「空」の状態です。

サンプルコードでは、このメソッドで作成されたドキュメントを saveHTML() メソッドでHTML文字列として出力し、その初期内容を確認しています。このように、createEmpty() はHTMLドキュメント操作の出発点として機能し、この後に要素を追加したり、テキストを挿入したりすることで、目的のHTMLコンテンツを構築していくことが可能です。

Dom\HTMLDocument::createEmpty()は、新しいHTML5ドキュメントの最小限の構造（<!DOCTYPE html><html><head></head><body></body></html>）を持つ「空」のオブジェクトを作成します。完全に何も含まないわけではなく、基本的なHTMLの骨組みが既に用意されている点にご注意ください。デフォルトの文字エンコーディングはUTF-8ですが、引数で別のエンコーディングを指定し、変更することも可能です。このメソッドは、HTMLドキュメントをプログラムでゼロから構築し始める際に利用します。既存のHTMLファイルを読み込んで操作したい場合は、別のメソッドを使用することになりますので、目的に応じて適切に使い分けましょう。