【PHP8.x】DOCUMENT_POSITION_FOLLOWING定数の使い方

DOCUMENT_POSITION_FOLLOWING定数の使い方について、初心者にもわかりやすく解説します。

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

基本的な使い方

DOCUMENT_POSITION_FOLLOWING定数は、PHPのDOM拡張機能において、文書ツリー内の2つのノード間の位置関係を表す定数の一つです。この定数は、主にDOMNode::compareDocumentPositionメソッドの戻り値として使用されます。DOMNode::compareDocumentPositionメソッドは、あるノードが別のノードに対して、文書ツリー上のどの位置にあるかを示す整数値を返しますが、DOCUMENT_POSITION_FOLLOWINGはその戻り値に含まれる値の一つとして、比較対象のノードが基準となるノードよりも文書のより後に出現することを示します。

具体的には、HTMLやXML文書を先頭から順に読み進めていく際に、基準となるノードの次に比較対象のノードが現れる場合、この定数が示す値がcompareDocumentPositionメソッドの戻り値に含まれます。例えば、<body>タグの中に<div>タグがあり、その直後に<p>タグがあるとします。この時、<div>タグを基準ノードとして<p>タグを比較対象ノードとした場合、<p>タグは<div>タグに続く位置にあるため、compareDocumentPositionメソッドはDOCUMENT_POSITION_FOLLOWINGの値を含んだ結果を返します。

この定数はDOMNodeクラスに定義されていますが、DOMElementクラスもDOMNodeを継承しているため、DOMElementオブジェクトに対してもこのメソッドを適用し、定数を利用することができます。この定数を利用することで、プログラムはDOMツリー内の要素の順序関係を正確に判断し、それに基づいた処理を実装することが可能になります。これは、特に文書構造の解析や操作を行う際に非常に重要な情報となります。

構文(syntax)


1<?php
2echo DOMElement::DOCUMENT_POSITION_FOLLOWING;
3?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

戻り値なし

戻り値はありません