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

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

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

基本的な使い方

bodyプロパティは、PHPのDom\Documentクラスに属し、HTMLドキュメントの<body>要素を保持するプロパティです。Dom\Documentオブジェクトは、HTMLやXMLといったドキュメント全体を表現するものであり、このプロパティを通じてドキュメントの本体部分に直接アクセスできます。

このプロパティが保持するのは、Dom\Element型のオブジェクトです。これは、HTMLドキュメント内の<body>タグによって定義される要素を表現します。例えば、Webページのコンテンツ本体に新しい要素（例えば段落や画像など）を追加したり、既存の要素のテキスト内容や属性を変更したりする場合に、このbodyプロパティから得られるDom\Elementオブジェクトを通じて操作を行います。

注意点として、もし解析対象のドキュメントがHTML形式ではなく<body>要素を含まないXMLドキュメントである場合や、HTMLドキュメントであっても何らかの理由で<body>要素が存在しない場合には、このbodyプロパティはnullを返します。そのため、利用する際には、返り値がnullではないことを確認する処理を挟むことが推奨されます。このプロパティは読み取り専用であり、新しい<body>要素を直接代入してドキュメント構造を変更することはできません。

構文(syntax)


1<?php
2$document = new \Dom\Document();
3$document->loadHTML('<!DOCTYPE html><html><head><title>Example</title></head><body><p>This is the body content.</p></body></html>');
4$bodyElement = $document->body;
5?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

?DOMElement

Dom\Document::body プロパティは、HTML ドキュメントの <body> 要素を表す DOMElement オブジェクト、または <body> 要素が存在しない場合は null を返します。

サンプルコード

PHP DomDocumentでbody要素を取得・操作する


1<?php
2
3// DomDocument を作成
4$dom = new DOMDocument('1.0', 'UTF-8');
5
6// HTML をロード
7$dom->loadHTML('<!DOCTYPE html><html><head><title>Example</title></head><body><h1>Hello, world!</h1></body></html>');
8
9// body 要素を取得
10$body = $dom->body;
11
12// body 要素が存在するか確認
13if ($body instanceof DOMElement) {
14    // body 要素の innerHTML を表示（デバッグ用）
15    echo "Body innerHTML: " . $body->nodeValue . PHP_EOL;
16
17    // body 要素に class 属性を追加する例
18    $body->setAttribute('class', 'main-content');
19
20    // もう一度 body 要素を取得（変更を反映するため、必要に応じて）
21    $body = $dom->body;
22
23    // class 属性を表示（デバッグ用）
24    echo "Body class: " . $body->getAttribute('class') . PHP_EOL;
25
26    // HTML 全体を保存（確認用）
27    echo $dom->saveHTML();
28} else {
29    echo "Body element not found." . PHP_EOL;
30}
31
32?>

このサンプルコードは、PHPのDOMDocumentクラスを使用して、HTMLドキュメント内の<body>要素にアクセスし、操作する方法を示しています。まず、DOMDocumentオブジェクトを作成し、loadHTML()メソッドでHTML文字列を読み込みます。

次に、$dom->bodyプロパティを使用して、ドキュメントの<body>要素を取得します。このbodyプロパティは、DOMElementオブジェクトまたはnullを返します。<body>要素が存在しない場合はnullが返されるため、instanceof演算子で要素が存在するかどうかを確認します。

<body>要素が存在する場合、サンプルコードではnodeValueプロパティを使用して<body>要素のテキストコンテンツ（innerHTML）を表示し、デバッグに役立てています。さらに、setAttribute()メソッドを使用して<body>要素にclass属性を追加する例を示しています。

getAttribute()メソッドを使用すると、属性の値を取得できます。ここでは、class属性の値を取得して表示しています。最後に、saveHTML()メソッドを使用して、変更が加えられたHTMLドキュメント全体を文字列として出力します。これにより、class属性が追加された<body>要素を含む完全なHTMLを確認できます。

このサンプルコードは、HTMLの構造をプログラムで操作する基本的な方法を理解するのに役立ちます。特に、既存のHTMLドキュメントに対して、特定の要素に属性を追加したり、内容を変更したりする際に有用です。$dom->bodyプロパティは、<body>要素への直接的なアクセスを提供し、DOM操作を簡略化します。

$dom->bodyは、HTMLドキュメントの<body>要素をDOMElementオブジェクトとして返します。<body>要素が存在しない場合、nullを返す可能性があります。そのため、必ずinstanceof DOMElementで型チェックを行い、要素が存在することを確認してから操作してください。loadHTML()でHTMLを読み込む際、文字コードに注意し、UTF-8など適切なエンコーディングを指定してください。setAttribute()で属性を変更した場合、再度$dom->bodyで要素を取得しなくても変更は反映されますが、処理によっては再取得が必要になる場合があります。saveHTML()で保存する際、DOCTYPE宣言や文字コード指定が正しく出力されるか確認してください。

PHP: JSONからbody要素を生成する


1<?php
2
3// JSON データから HTML ドキュメントを生成し、body 要素を取得する例
4function getBodyFromJSON(string $jsonData): ?DOMElement
5{
6    try {
7        // JSON データを連想配列に変換
8        $data = json_decode($jsonData, true, 512, JSON_THROW_ON_ERROR);
9
10        // DOMDocument を作成
11        $dom = new DOMDocument('1.0', 'UTF-8');
12
13        // HTML 要素を作成
14        $html = $dom->createElement('html');
15        $dom->appendChild($html);
16
17        // body 要素を作成
18        $body = $dom->createElement('body');
19        $html->appendChild($body);
20
21        // JSON データから body 要素にコンテンツを追加
22        if (is_array($data)) {
23            foreach ($data as $key => $value) {
24                $element = $dom->createElement($key, htmlspecialchars((string)$value));
25                $body->appendChild($element);
26            }
27        }
28
29        return $body;
30
31    } catch (JsonException $e) {
32        // JSON デコードエラー
33        error_log("JSON decode error: " . $e->getMessage());
34        return null;
35    } catch (Exception $e) {
36        // その他のエラー
37        error_log("Error: " . $e->getMessage());
38        return null;
39    }
40}
41
42// JSON データの例
43$jsonData = '{ "name": "John Doe", "age": 30, "city": "New York" }';
44
45// body 要素を取得
46$bodyElement = getBodyFromJSON($jsonData);
47
48// body 要素が存在する場合、内容を出力
49if ($bodyElement) {
50    echo "Body Element: \n";
51    echo $bodyElement->ownerDocument->saveHTML($bodyElement);
52
53} else {
54    echo "Failed to retrieve body element.\n";
55}
56?>

このサンプルコードは、PHPのDom\Documentクラスにおけるbodyプロパティの利用例を示しています。具体的には、JSON形式のデータからHTMLドキュメントを生成し、そのドキュメントのbody要素を取得する方法を解説します。

getBodyFromJSON関数は、JSON文字列を引数として受け取ります。まず、json_decode関数を使ってJSONデータを連想配列に変換します。この際、JSON_THROW_ON_ERRORフラグを指定することで、JSONのデコードに失敗した場合に例外を発生させることができます。

次に、DOMDocumentオブジェクトを作成し、html要素とbody要素を順に生成して、ドキュメントに追加します。JSONデータが連想配列の場合、キーと値をそれぞれ要素名と要素の値として、body要素の子要素として追加していきます。htmlspecialchars関数でエスケープ処理を行うことで、HTML特殊文字が正しく表示されるようにします。

関数は、生成されたbody要素をDOMElement型で返します。JSONデコードエラーやその他のエラーが発生した場合は、エラーログを出力し、nullを返します。

サンプルコードでは、JSONデータの例として、名前、年齢、都市の情報を持つJSON文字列を使用しています。getBodyFromJSON関数を呼び出してbody要素を取得し、取得に成功した場合は、saveHTMLメソッドを使ってbody要素の内容をHTMLとして出力します。取得に失敗した場合は、エラーメッセージを表示します。

この例を通して、JSONデータを元に動的にHTMLを生成し、body要素にアクセスする方法を学ぶことができます。

サンプルコードの注意点と補足です。DOMDocumentを扱う際、bodyプロパティはドキュメントが適切に作成されないとnullを返す可能性があります。JSONデータをHTML要素に変換する際、htmlspecialcharsでエスケープ処理を行い、XSS攻撃を防ぐようにしましょう。また、JSONデータの構造が複雑な場合、再帰的な処理が必要になることがあります。エラーハンドリングは重要で、JsonExceptionだけでなく、他の例外も考慮し、ログ出力などで原因を特定できるようにしましょう。saveHTMLメソッドでbody要素の内容を文字列として取得する際は、ownerDocumentを経由する必要がある点に注意してください。