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

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

作成日: 2025年09月11日更新日: 2025年10月29日

基本的な使い方

『containsメソッドは、あるノードが、このメソッドを呼び出したノードの子孫であるかどうかを判定するメソッドです。HTMLやXML文書の階層構造（DOMツリー）において、ノード間の包含関係を調べる際に使用します。このメソッドは、引数として渡されたノードオブジェクトが、現在のノードオブジェクトの中に含まれているかどうかを真偽値（bool）で返します。ここでの「含まれている」とは、直接の子ノードである場合に限らず、孫やひ孫といった、より深い階層に存在するすべての子孫ノードが対象となります。例えば、<body>要素を表すノードからこのメソッドを呼び出し、引数にその<body>要素内にある<p>要素のノードを渡した場合、trueが返されます。一方、引数で指定したノードが子孫ではない場合や、引数がnullである場合はfalseを返します。注意点として、自分自身のノードを引数に渡した場合は、直接の子孫関係にはあたらないためfalseが返される仕様となっています。このメソッドにより、特定の要素が別の要素の内部に存在するかどうかを効率的に確認することができます。』

構文(syntax)


1<?php
2
3$parent = new DOMElement('parent');
4$child = new DOMElement('child');
5$parent->appendChild($child);
6
7$isContained = $parent->contains($child);
8
9?>

引数(parameters)

DOMNode|DOMNameSpaceNode|null $other

DOMNode|DOMNameSpaceNode|null $other: 比較対象となるDOMNodeまたはDOMNameSpaceNodeオブジェクト、あるいはnull

戻り値(return)

bool

指定されたDOMNodeが、このDOMNodeのツリー内に含まれているかどうかを示す真偽値を返します。