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

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

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

基本的な使い方

containsメソッドは、引数で指定したノードが、そのDocumentオブジェクトの子孫であるかどうかを判定するために実行するメソッドです。このメソッドは、確認したいDOM\Nodeオブジェクトを引数として受け取り、そのノードがドキュメントのDOMツリー内に存在すればtrueを、存在しなければfalseを返します。ここで言う「子孫」とは、直接の子ノードだけでなく、そのさらに下層にある孫ノードなど、ドキュメントに含まれるすべてのノードを指します。また、Documentオブジェクト自身を引数に指定した場合も、そのノードは自身に含まれているとみなされtrueが返ります。一方で、引数で指定したノードがこのドキュメントのDOMツリーに属していない場合や、引数がnullである場合はfalseを返します。このメソッドを利用することで、特定のノードが現在のドキュメントの一部であるかを安全に確認し、意図しないノード操作を防ぐことができます。

構文(syntax)


1<?php
2
3$document = new Dom\Document();
4$document->loadHTML('<html><body><p>test</p></body></html>');
5
6// ドキュメント内に存在するノードを取得
7$node = $document->getElementsByTagName('p')->item(0);
8
9// 構文: public function contains(?Dom\Node $other): bool
10$isContained = $document->contains($node);
11
12var_dump($isContained); // bool(true)
13
14?>

引数(parameters)

?Dom\Node $other

?Dom\Node $other: 比較対象となるDOMノードを指定します。このノードが現在のDom\Documentのツリー内に存在するかどうかを確認します。

戻り値(return)

戻り値なし

戻り値はありません