PHP 8.4からはHTMLパーサーはDOM拡張モジュール「Dom\HTMLDocument」が使いやすくなった。
- 掲載日
- 更新日
業務でPHPを使用しているのですが、長年HTMLパーサーの選定に苦労していました。
ライブラリはあり、phpquery、DiDomといったjQueryライクにHTMLを操作できるライブラリを使用させて頂いたのですが、どちらも残念ながらメンテナンスが停止しています。
※ DiDomは今の所非推奨エラーが出るだけなのでphp.iniをでエラーメッセージを出さないようにしてしまえば動いてしまいますが、今後のことを考えると乗り換えが必要になっています。
(symfony/dom-crawlerというライブラリは随分昔からあり、今もメンテされているのでこちらを使ってればそんなに大変じゃなかったかも。)
これまでもDOMDocumentというパーサーがDOM拡張モジュールとして存在していたのですが、これはcssセレクターが使えずXPathを使う必要がありました。
XPathだと、今までcssセレクターで書いていたコードの差し替えコストが高くなってしまうので中々移行に踏み切れなかったのですが、なんとphp8.4からはDom\HTMLDocumentが追加され、クエリセレクターが使えるようになりました。
これでバージョンアップに対応しやすくなるはずと思い、移行を決断したので、その使用方法とDiDomからの移行をまとめました。
空のインスタンス作成
0からHTML組み立てる場合等、空のインスタンスが必要な時はDom\HTMLDocument::createEmpty()で作成します。
// DiDomの場合
$doc = new Document();
// Dom\HTMLDocumentの場合
$doc = Dom\HTMLDocument::createEmpty();HTMLを作成する
1からHTML文章を作成する場合や、何らかの文章を加工して途中に特定タグを追加する場合、createElement()を使います。作った要素をappendすることで要素を追加できます。
この辺りはDiDomも同じ関数で同じことが出来るので移行が楽ですね。
(※ DiDomは第二引数に配列でclassやid等の属性を追加できましたがそれは出来ないので移行時注意。)
$doc = HTMLDocument::createEmpty();
$div = $doc->createElement("div");
$doc->append($div);
echo var_dump($doc->saveHtml());
// => <div></div>HTMLを読み込む
まずはHTMLを読み込みます。文章、ファイルどちらを読み込むかでそれぞれ呼び出す関数が違うのでDiDom使ってた場合移行時に注意が必要です。
文章読み込み
// DiDomの場合
$doc = new Document('<!DOCTYPE html><html><body><p>hoge</p></body></html>');
// Dom\HTMLDocumentの場合
$doc = HTMLDocument::createFromString('<!DOCTYPE html><html><body><p>hoge</p></body></html>');なお、<div>hoge</div>のように途中の文章だけ読み取るとエラーが出ます。
そういう用途で使いたい場合、LIBXML_NOERRORオプションを付けて読み取ります。
$doc = HTMLDocument::createFromString('<div>hoge</div>', LIBXML_NOERROR);
echo sprintf("%s\n", $doc->saveHtml());
// => <html><head></head><body><div>hoge</div></body></html>なお、このオプションを付けていても、出力時にはhtmlタグが付与された状態になります。
出力時にはbodyタグのinnerHTMLを出力するようにする等の工夫が必要になります。
$html = "<div>hoge</div>";
$doc = HTMLDocument::createFromString($html, LIBXML_NOERROR);
echo sprintf("%s\n", $doc->body->innerHTML);ファイル読み込み
// DiDomの場合
$doc = new Document('/path/to/file.html', true);
// Dom\HTMLDocumentの場合
$doc = Dom\HTMLDocument::createFromFile('/path/to/file.html');DiDomの場合空のインスタンス作成した後にload(string html or filepath, bool isFile)で文章を読み取ることも可能でしたが、Dom\HTMLDocumentはそれは出来なさそうなので注意が必要です。
読み取ったHTMLを操作する
タグを取得する
例えばaタグを取得する場合、querySelectorを使用します。
// DiDomの場合
$doc->first("a");
// Dom\HTMLDocumentの場合
$doc->querySelector("a");querySelector関数は最初の一個だけ取得するので、DiDomのfirstのような感覚で扱えます。
特定のクラスの一覧を取得する場合はquerySelectorAllを使用します。
// DiDomの場合
$item = $doc->find(".items");
// Dom\HTMLDocumentの場合
$item = $doc->querySelectorAll(".items");
// そのままforeach可能
foreach ($doc->querySelectorAll(".items") as $item) {
echo sprintf("%s\n", $item->textContent);
}Attribute(属性)を取得する・設定する
タグのAttributeを取得する場合は、getAttribute(属性名)を、新たに設定する場合はsetAttribute(属性名, 値)を使用します。
// DiDomの場合
$item->attr("class");
$item->attr("class", "hoge");
// Dom\HTMLDocumentの場合
$item->getAttribute("class");
$item->setAttribute("class", "hoge");タグの内容(テキスト)を取得・変更する
タグの中の文字列を参照する場合、textContentプロパティを使います。変更する時はそのまま上書きすればOKです。
// DiDomの場合
echo sprintf("%s\n", $item->text());
$item->setValue('テキスト');
// Dom\HTMLDocumentの場合
echo sprintf("%s\n", $item->textContent);
$item->textContent = "hoge";こっちは逆にDiDomの方が取得と変更で関数が違うので注意が必要です。
タグの内容(HTML)を取得・変更する
タグの中のHTMLを参照する場合、innerHTMLプロパティを使います。
自分自身も含める場合はouterHTMLもしくはsaveHtml()を使います。
outerHTMLはphp8.5から追加されているので、環境に合わせて使用してください。
php8.4環境の場合、replaceWithを使って同じような操作が可能です。(もっと楽な方法あるかも。)
// DiDomの場合
$item->innerHtml();
$item->setInnerHtml('<p>hoge</p>');
$item->html(); // ※ 自分自身を含める場合
// Dom\HTMLDocumentの場合
$item->innerHtml();
$item->setInnerHtml('<p>hoge</p>');
$item->outerHTML = "<div><p>hoge</p></div>"; // ※ PHP8.5から
// ※ PHP8.4でouterHTMLみたいなことをする場合
$div = $doc->createElement('div');
$p = $doc->createElement('p');
$p->textContent = "ほげ";
$div->append($p);
$item->replaceWith($div);操作したHTMLを出力する
作成や修正したHTMLを出力する場合、saveHtml()を使用します。
ただし、読み取りの際に触れた通り、htmlタグ無で読み取った文章も、htmlタグ付きで出力します。
場合によってはbodyのinnerHTMLを取得してください。
$doc->saveHtml();
// htmlタグ無の文章が欲しい場合、$doc->body->innerHTMLおわりに
まだ導入されたばかりですが、(既存のDomDocumentもあったためか)HTMLパーサーとして必要な関数はあらかた揃っているので、これからはパーサーに悩む必要が無くなりそうです。
symfony/dom-crawler等を使っていた人はそのまま使い続けても支障はないと思いますが、DiDom等を使っていた人はこの機会に乗り換えてはいかがでしょうか。
関連リンク
- phpqueryのGitHubリンク
- DiDomのGitHubリンク
どちらも3年ほど前にメンテが止まっているので利用は推奨しません。
お世話になったので記録として残します。


