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

insertAdjacentElementメソッドは、呼び出し元の要素ノードを基準として、指定された位置に別の要素ノードを挿入するメソッドです。このメソッドの最大の特徴は、要素の内部だけでなく、要素の前後にも新しい要素を追加できる点にあります。第一引数 $where には、挿入位置を示す文字列を指定します。指定可能な値は 'beforebegin'、'afterbegin'、'beforeend'、'afterend' の4つです。'beforebegin'は要素自身の直前に、'afterbegin'は要素の最初の子要素として、'beforeend'は要素の最後の子要素として、そして'afterend'は要素自身の直後に挿入します。第二引数 $element には、挿入したい Dom\Element オブジェクトを渡します。処理が成功した場合、挿入された要素自身が返り値となります。しかし、親ノードが存在しない要素に対して 'beforebegin' や 'afterend' を使用するなど、挿入が不可能な状況では null を返します。これにより、DOMツリーの特定の位置へ正確かつ柔軟に要素を配置することができます。

Copy
1public function insertAdjacentElement(string $where, Dom\Element $element): ?Dom\Element

Dom\AdjacentPosition $where, Dom\Element $element

• Dom\AdjacentPosition $where: 要素を挿入する相対位置を指定します。
• Dom\Element $element: 挿入するDOM要素を指定します。

?Dom\Element

指定された位置に挿入された新しい Dom\Element オブジェクト、または挿入に失敗した場合は null を返します。