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

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

作成日: 2025年09月11日更新日: 2025年10月28日

基本的な使い方

createHTMLDocumentメソッドは、新しいHTMLドキュメントをプログラム上で作成するためのメソッドです。これは、Dom\Implementationクラスに属しており、HTML5の仕様に準拠した空のDOMDocumentオブジェクトを生成します。

DOMDocumentオブジェクトとは、HTMLやXML文書の構造をメモリ上でツリー状に表現し、プログラムからその構造を操作するための基盤となるものです。このメソッドを使うと、WebページのようなHTML構造を持つ文書をゼロから構築することができます。具体的には、基本的な<!DOCTYPE html>宣言や<html>、<head>、<body>といった要素があらかじめ設定されたDOMDocumentオブジェクトが返されます。引数に文字列を渡すことで、生成されるHTMLドキュメントの<title>要素の内容を初期設定することが可能です。

返されるDOMDocumentオブジェクトは、その後、DOM（Document Object Model）の様々な操作メソッドを使って、要素を追加したり、属性を変更したりすることで、動的にHTMLコンテンツを構築していく基盤となります。例えば、appendChildメソッドで新しい要素を追加したり、createElementメソッドで要素を作成したりすることが可能になります。これにより、PHPスクリプト内で複雑なHTML構造を簡単に生成・操作できるようになります。既存のHTMLを読み込むのではなく、まっさらなHTML文書を効率的に作成したい場合に特に役立ちます。

構文(syntax)


1<?php
2
3$domImplementation = new Dom\Implementation();
4$htmlDocument = $domImplementation->createHTMLDocument();
5
6?>

引数(parameters)

?string $title = null

?string $title = null: 作成するHTMLドキュメントのタイトルを指定する文字列。省略時はタイトルなしで作成されます。

戻り値(return)

Dom\HTMLDocument

このメソッドは、新しい空の HTML 文書を表す Dom\HTMLDocument オブジェクトを返します。

サンプルコード

PHPでHTMLドキュメントを作成・操作する


1<?php
2
3// Dom\Implementation クラスは、DOM Level 2 Core で定義されている DOM の実装を表します。
4// createHTMLDocument メソッドは、新しい HTML5 ドキュメントを作成するために使用されます。
5
6/**
7 * Dom\Implementation::createHTMLDocument の使用例を示します。
8 * 新しい HTML ドキュメントを作成し、その内容を操作して出力します。
9 */
10function createAndManipulateHtmlDocument(): void
11{
12    // 1. Dom\Implementation クラスのインスタンスを作成します。
13    //    このインスタンスを通して、新しいドキュメントを作成するメソッドを呼び出します。
14    $domImplementation = new Dom\Implementation();
15
16    // 2. createHTMLDocument メソッドを使用して、新しい HTML5 ドキュメントを作成します。
17    //    引数に文字列を渡すことで、HTML の <title> 要素が設定されます。
18    //    引数を省略した場合、タイトルは設定されません。
19    $htmlDocument = $domImplementation->createHTMLDocument('PHP DOM サンプルページ');
20
21    // 3. 生成された Dom\HTMLDocument オブジェクトを操作します。
22    //    例えば、<body>要素に新しい要素を追加できます。
23    //    Dom\HTMLDocument::body プロパティは、ドキュメントの <body>要素へのショートカットです。
24    $body = $htmlDocument->body;
25
26    // body要素が確実に存在するか確認します（通常、createHTMLDocument は body を生成します）。
27    if ($body !== null) {
28        // h1要素を作成し、テキストノードを追加します。
29        $h1 = $htmlDocument->createElement('h1', 'ようこそ、PHP DOMの世界へ！');
30        $body->appendChild($h1);
31
32        // p要素を作成し、テキストノードを追加します。
33        $p = $htmlDocument->createElement('p', 'これは Dom\\Implementation::createHTMLDocument で生成されたサンプルページです。');
34        $body->appendChild($p);
35    }
36
37    // 4. 生成された HTML ドキュメントの内容を文字列として取得し、出力します。
38    //    通常、Webサーバー経由でブラウザに送信されるような完全なHTML文字列が得られます。
39    echo $htmlDocument->saveHTML();
40}
41
42// 関数を呼び出して実行します。
43createAndManipulateHtmlDocument();
44
45?>

PHP 8のDom\Implementation::createHTMLDocumentメソッドは、新しいHTML5ドキュメントを簡単に作成するための機能です。このメソッドは、Dom\Implementationクラスのインスタンスから呼び出されます。

引数にはオプションで文字列$titleを指定でき、これは作成されるHTMLドキュメントの<title>要素に設定されます。引数を省略した場合、タイトルは設定されません。メソッドはDom\HTMLDocumentオブジェクトを戻り値として返します。このオブジェクトは、作成されたHTMLドキュメント全体を表し、要素の追加や変更といったDOM操作を行うための機能を提供します。

サンプルコードでは、まずDom\Implementationのインスタンスを作成し、createHTMLDocument()メソッドを呼び出して新しいHTMLドキュメントを生成しています。生成されたDom\HTMLDocumentオブジェクトを利用し、そのbodyプロパティから<body>要素にアクセスしています。そして、createElementメソッドで<h1>や<p>などの新しいHTML要素を作成し、appendChildメソッドでそれらを<body>に追加することで、ドキュメントの内容を構築しています。最終的に、saveHTML()メソッドにより、完成したHTMLドキュメント全体の構造が文字列として取得され、出力されます。これにより、プログラムで動的にHTMLコンテンツを生成し、Webページとして利用することが可能です。

Dom\Implementationクラスのインスタンスをまず作成する必要がある点に注意してください。createHTMLDocumentメソッドは、HTML5に準拠した新しいドキュメントを生成します。引数に文字列を渡すと、HTMLの<title>要素が設定されますが、省略することも可能です。戻り値はDom\HTMLDocumentオブジェクトで、このオブジェクトに対し、createElementやappendChildなどのメソッドを使ってDOM要素を構築・操作します。特に、$htmlDocument->bodyプロパティで直接<body>要素にアクセスできるため、ページのコンテンツ追加の起点として活用できます。完成したドキュメントは、saveHTML()メソッドで完全なHTML文字列として取得し、出力します。

PHP 8 Dom API でHTMLドキュメントを作成する


1<?php
2
3/**
4 * PHP 8 の新しい Dom 拡張を使ってHTMLドキュメントを作成し、
5 * 要素を追加するサンプルコードです。
6 *
7 * Dom\DOMImplementation クラスの createHTMLDocument メソッドを利用し、
8 * 作成された Dom\HTMLDocument オブジェクトに対して
9 * createElement や appendChild メソッドを使って要素を操作します。
10 */
11function createAndManipulateHtmlDocument(): string
12{
13    // Dom\DOMImplementation のインスタンスを作成します。
14    // これは、新しいDOMドキュメントを作成するための機能を提供します。
15    $domImplementation = new Dom\DOMImplementation();
16
17    // createHTMLDocument メソッドで新しいHTML5ドキュメントを作成します。
18    // 引数にはドキュメントのタイトルを指定できます。
19    $htmlDocument = $domImplementation->createHTMLDocument('PHP DOM サンプル');
20
21    // ドキュメントの <body> 要素を取得します。
22    // getElementsByTagName はコレクションを返すため、item(0) で最初の要素を取得します。
23    $body = $htmlDocument->getElementsByTagName('body')->item(0);
24
25    // キーワード 'createelement' に関連する操作: 新しい div 要素を作成します。
26    // ドキュメントオブジェクト ($htmlDocument) の createElement メソッドを使います。
27    $newDiv = $htmlDocument->createElement('div');
28    $newDiv->textContent = 'こんにちは！これは新しい div 要素です。';
29
30    // 別な新しい p 要素を作成し、テキストを設定します。
31    $newParagraph = $htmlDocument->createElement('p');
32    $newParagraph->textContent = 'この段落はプログラムから追加されました。';
33
34    // 作成した要素を <body> 要素に追加します。
35    // appendChild メソッドは、指定した親要素の子として要素を追加します。
36    if ($body) { // body 要素が存在するか確認します。
37        $body->appendChild($newDiv);
38        $body->appendChild($newParagraph);
39    }
40
41    // 完成したHTMLドキュメントを文字列として取得し、返します。
42    return $htmlDocument->saveHTML();
43}
44
45// 関数を実行し、生成されたHTMLを出力します。
46echo createAndManipulateHtmlDocument();
47

このサンプルコードは、PHP 8で導入された新しいDom拡張を使って、プログラムからHTMLドキュメントを生成し、要素を追加・操作する方法を示しています。

まず、Dom\DOMImplementationクラスのインスタンスを作成します。このクラスは、新しいDOMドキュメントを作成するための機能を提供します。次に、createHTMLDocumentメソッドを呼び出すことで、新しいHTML5ドキュメントをゼロから作成します。このメソッドは、引数として?string $titleを受け取り、ドキュメントの<title>タグに設定する文字列を任意で指定できます。引数を省略した場合、タイトルは設定されません。メソッドの戻り値は、操作可能なDom\HTMLDocumentオブジェクトであり、これが作成されたHTMLドキュメント全体を表します。

このDom\HTMLDocumentオブジェクトを利用して、createElementメソッドで新しいHTML要素（例えばdiv要素やp要素）を生成できます。作成した要素にはtextContentプロパティでテキストコンテンツを設定し、getElementsByTagNameメソッドで既存の<body>要素などを取得した後、appendChildメソッドを使って、それらの要素を子要素として追加していきます。

最終的に、$htmlDocument->saveHTML()メソッドを呼び出すことで、プログラムによって構築された完全なHTMLドキュメントを文字列として取得し、出力することが可能です。これにより、動的にHTMLコンテンツを生成する処理を実現できます。

このサンプルコードはPHP 8から導入された新しいDom拡張を使用しています。Dom\DOMImplementationクラスのcreateHTMLDocumentメソッドは、HTML5の基本構造を自動生成するため、手動で構築する手間が省け便利です。

getElementsByTagNameで要素を取得する際は、複数の結果が返される可能性があるため、item(0)で目的の要素を確実に指定してください。また、要素が見つからない場合に備え、if ($body)のようなnullチェックを行う習慣は、予期せぬエラーを防ぎプログラムを安定させる上で重要です。

createElementで作成した要素は、appendChildメソッドを使って適切な親要素に必ず追加する必要があります。最終的にsaveHTML()で、構築したHTMLドキュメントが文字列として出力されます。これらの手順を理解することで、DOM操作の基本を習得できます。