【PHP8.x】loadメソッドの使い方

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

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

基本的な使い方

loadメソッドは、XMLドキュメントをファイルから読み込み、DOMDocumentオブジェクトにロードするメソッドです。このメソッドを使用することで、ローカルファイルシステム上のXMLファイルを解析し、その内容をプログラム内で操作可能なDOM（Document Object Model）構造に変換できます。

具体的には、loadメソッドはファイルパスを引数として受け取り、指定されたパスにあるXMLファイルを読み込みます。ファイルが存在しない場合や、XMLの構文エラーが含まれている場合は、警告またはエラーが発生することがあります。エラー処理を行うためには、libxmlのエラーハンドリング関数を使用するか、libxml_use_internal_errors()関数で内部エラーハンドリングを有効にすることを推奨します。

loadメソッドは、XMLドキュメントの構造を解析し、要素、属性、テキストノードなどのDOMノードを作成します。これらのノードは、DOMDocumentオブジェクトのプロパティとしてアクセスできるようになります。その後、これらのノードに対して、追加、削除、変更などの操作を行うことで、XMLドキュメントをプログラム的に編集できます。

また、LIBXML_定数群をオプションとして指定することで、XMLパーサの動作を制御できます。例えば、空白を削除したり、エンティティ置換を行わないようにしたり、DTDバリデーションを実行したりすることができます。これらのオプションを使用することで、特定のXMLドキュメントに対する解析処理を最適化したり、セキュリティリスクを軽減したりすることが可能です。

loadメソッドの戻り値は、XMLドキュメントのロードが成功した場合はtrue、失敗した場合はfalseです。この戻り値をチェックすることで、ロード処理が正常に完了したかどうかを確認し、必要に応じてエラー処理を行うことができます。

構文(syntax)


1DOMDocument::load(string $filename, ?int $options = null): bool

引数(parameters)

string $filename, int $options = 0

string $filename: ロードするXMLファイルへのパスを指定します。
int $options = 0: ロード時のオプションを指定します。デフォルトは0で、追加のオプションは指定されません。

戻り値(return)

true

DOMDocument::load メソッドは、XML または HTML ファイルを読み込み、成功した場合は true を返します。

サンプルコード

PHP DOMDocument loadでHTMLを読み込む


1<?php
2
3// DOMDocument を使用して HTML ファイルを読み込む例
4
5// DOMDocument オブジェクトを生成
6$dom = new DOMDocument();
7
8// 読み込む HTML ファイルのパス
9$filename = 'example.html';
10
11// ファイルが存在するか確認
12if (file_exists($filename)) {
13    // HTML ファイルを読み込む
14    // loadHTMLFile() の代わりに load() を使用
15    $result = $dom->load($filename);
16
17    // 読み込みが成功したか確認
18    if ($result) {
19        echo "HTML ファイルの読み込みに成功しました。\n";
20
21        // ルート要素を取得して表示（例）
22        $documentElement = $dom->documentElement;
23        if ($documentElement) {
24            echo "ルート要素: " . $documentElement->tagName . "\n";
25        }
26
27    } else {
28        echo "HTML ファイルの読み込みに失敗しました。\n";
29    }
30} else {
31    echo "ファイル '$filename' が存在しません。\n";
32}
33
34
35// サンプルとして HTML ファイルを生成（'example.html' が存在しない場合）
36if (!file_exists($filename)) {
37    $sampleHTML = '<!DOCTYPE html><html><head><title>Sample HTML</title></head><body><h1>Hello, world!</h1></body></html>';
38    file_put_contents($filename, $sampleHTML);
39    echo "'example.html' を作成しました。\n";
40}
41
42?>

このサンプルコードは、PHPのDOMDocumentクラスのloadメソッドを使用して、HTMLファイルを読み込む方法を示しています。まず、DOMDocumentクラスの新しいオブジェクトを生成します。次に、読み込むHTMLファイルのパスを $filename 変数に格納します。file_exists()関数を使って、指定されたファイルが存在するかどうかを確認し、存在する場合にのみ読み込み処理を行います。

$dom->load($filename) で、指定されたHTMLファイルをDOMDocumentオブジェクトに読み込みます。load()メソッドは、読み込みが成功した場合は true、失敗した場合は false を返します。この戻り値を $result 変数に格納し、読み込みが成功したかどうかを確認します。

読み込みが成功した場合、ルート要素を取得してそのタグ名を表示する簡単な例を示しています。$dom->documentElement でルート要素を取得し、$documentElement->tagName でタグ名を取得できます。

ファイルが存在しない場合は、サンプルとして簡単なHTMLファイルを $filename で指定されたパスに作成します。これは、コードを初めて実行する際に、HTMLファイルが存在しない場合に備えて、動作確認をしやすくするためのものです。file_put_contents()関数を使用してHTMLファイルを作成します。

load()メソッドは、第一引数に読み込むファイルパス（文字列）を指定します。オプションとして、第二引数に整数型の $options を指定できますが、この例ではデフォルト値の 0 を使用しています。load()メソッドは、指定されたファイルを解析し、その内容をDOMDocumentオブジェクトに反映させます。

DOMDocumentのload()メソッドは、指定したファイルからXMLまたはHTMLを読み込みます。引数にはファイルパスを文字列で指定します。

初心者が注意すべき点として、ファイルパスの指定を間違えないようにしてください。相対パスで指定する場合は、スクリプト実行時のカレントディレクトリからの相対位置になります。

また、load()メソッドは成功時にtrue、失敗時にfalseを返します。戻り値を確認して、エラー処理を行うようにしましょう。

サンプルコードではfile_exists()でファイルの存在を確認していますが、さらにファイル読み込み権限なども確認するとより安全です。loadHTMLFile()ではなくload()を使用している点に注意してください。loadHTMLFile()はPHP 5で非推奨となり、PHP 8では削除されました。

PHP DOMDocument load で XML を読み込む


1<?php
2
3// DOMDocument を使用して XML ファイルを読み込むサンプル
4try {
5    $dom = new DOMDocument();
6
7    // XML ファイルを読み込みます
8    $filename = 'sample.xml'; // 読み込む XML ファイル名
9
10    // ファイルが存在するか確認
11    if (!file_exists($filename)) {
12        throw new Exception("ファイルが見つかりません: $filename");
13    }
14
15    $load_success = $dom->load($filename);
16
17    if ($load_success === false) {
18        throw new Exception("XMLファイルの読み込みに失敗しました。");
19    }
20
21    // XML のルート要素の名前を表示します
22    echo 'ルート要素: ' . $dom->documentElement->tagName . PHP_EOL;
23
24    // XML の内容を標準出力に出力
25    echo $dom->saveXML();
26
27} catch (Exception $e) {
28    echo 'エラー: ' . $e->getMessage() . PHP_EOL;
29}
30
31?>

このPHPサンプルコードは、DOMDocumentクラスのloadメソッドを使用してXMLファイルを読み込む方法を示しています。DOMDocumentはXMLドキュメントを操作するためのクラスです。

まず、DOMDocumentクラスのインスタンスを作成します。次に、loadメソッドにXMLファイルのパス（$filename）を引数として渡します。loadメソッドは、指定されたXMLファイルを読み込み、DOMDocumentオブジェクトにXMLドキュメントをロードします。

loadメソッドの第2引数 $options は、XMLの読み込みに関するオプションを指定できます。デフォルト値は0で、特別なオプションを指定しない場合は省略可能です。

loadメソッドは、XMLファイルの読み込みに成功した場合にtrueを、失敗した場合にfalseを返します。サンプルコードでは、loadメソッドの戻り値をチェックし、読み込みに失敗した場合は例外をスローしています。

ファイルが存在しない場合や、XMLの構造が正しくない場合など、読み込みに失敗する可能性があります。エラー処理として、try-catchブロックを使用し、例外が発生した場合にエラーメッセージを表示するようにしています。

正常に読み込みが完了した場合、サンプルコードではルート要素の名前を表示し、saveXMLメソッドを使用してXMLドキュメント全体を文字列として出力します。saveXMLメソッドは、DOMDocumentオブジェクトの内容をXML形式の文字列として返します。

DOMDocument::load()メソッドは、XMLファイルを読み込むための関数です。引数$filenameには、読み込むXMLファイルのパスを指定します。ファイルが存在しない場合や、ファイル形式が正しくない場合は、エラーが発生します。サンプルコードでは、file_exists()関数でファイルの存在を確認し、try-catchブロックで例外処理を行っています。$options引数は、XMLの解析オプションを指定するために使用します。省略した場合、デフォルト値の0が適用されます。load()メソッドの戻り値は、成功した場合はtrue、失敗した場合はfalseです。失敗した場合も例外を発生させるように記述すると、より堅牢なコードになります。