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

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

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

基本的な使い方

containsメソッドは、DOMDocumentに特定の要素が含まれているかどうかを判定するメソッドです。Dom\HTMLDocumentクラスに属しており、HTMLドキュメント内に特定の要素が存在するかどうかを確認する際に使用されます。このメソッドは、要素の存在を確認する上で重要な役割を果たし、条件分岐やエラーハンドリングなどの処理を実装する際に役立ちます。

具体的には、containsメソッドは、引数として指定された要素がドキュメント内に存在するかどうかを調べます。もし要素が存在すれば、通常はtrueを返し、存在しなければfalseを返します。この戻り値を利用することで、プログラムは要素の存在に基づいて異なる処理を実行できます。

例えば、特定のIDを持つ要素が存在するかどうかを確認し、存在する場合はその要素に対して処理を行い、存在しない場合はエラーメッセージを表示する、といった使い方が考えられます。このように、containsメソッドは、HTMLドキュメントの構造を解析し、特定の要素の存在を確認する上で非常に便利なツールとなります。

システムエンジニアを目指す初心者の方にとって、containsメソッドは、Webアプリケーション開発やスクレイピング処理など、HTMLドキュメントを扱う様々な場面で活用できる重要なメソッドです。HTMLドキュメント内の要素を効率的に検索し、必要な処理を行うための基礎となる知識として、ぜひ理解を深めてください。

構文(syntax)


1<?php
2$document = new Dom\HTMLDocument();
3$document->loadHTML('<html><body><div><p></p></div></body></html>');
4
5// チェック対象のノードを取得します
6$node = $document->getElementsByTagName('p')->item(0);
7
8// $document が $node を子孫として含んでいるかどうかの真偽値 (bool) を返します
9$result = $document->contains($node);
10?>

引数(parameters)

?Dom\Node $other

?Dom\Node $other: 検索対象のDOMノードを指定します。このノードが、現在のDom\HTMLDocument内に存在するかどうかを判定します。

戻り値(return)

bool

指定されたDOM要素が、このHTMLドキュメント内に存在するかどうかを示す真偽値を返します。存在する場合はtrue、存在しない場合はfalseを返します。