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

prependメソッドは、Dom\Elementクラスに属し、指定された子ノードまたはテキストを、要素の最初の子として追加するメソッドです。

このメソッドは、XMLやHTMLなどのドキュメントをPHPで操作する際に非常に役立ちます。具体的には、あるDOM要素、例えばHTMLの<div>要素に対して、新しい要素（例：<p>要素）やテキストコンテンツを、その要素の既存の子要素の「先頭」に挿入したい場合に使用します。

prependメソッドは可変長引数を受け入れるため、一度に複数のDom\Nodeオブジェクトや文字列を指定して追加することができます。引数として文字列を渡した場合、その文字列は自動的にテキストノードとして扱われ、挿入されます。これにより、新しいDOM要素を作成して挿入するだけでなく、手軽にテキストコンテンツを要素の先頭に追加することも可能です。

このメソッドは、操作が成功しても何も値を返しません（void）。呼び出し後には、対象となるDom\Elementオブジェクトの内部的な構造が変更され、指定されたノードが先頭の子として追加された状態となります。

Webページに動的に新しい情報を一番上に表示したい場合や、XMLデータ構造の特定の要素の最初にメタデータを挿入したい場合など、DOMツリーの構造を効率的に変更するための基本的な操作として活用されます。

Copy
1<?php
2
3// DOMドキュメントとルート要素を作成
4$dom = new \Dom\Document('1.0', 'UTF-8');
5$list = $dom->createElement('list');
6
7// 既存の子要素を追加
8$item = $dom->createElement('item', 'Original Item');
9$list->appendChild($item);
10
11// list要素の先頭に、新しい要素と文字列を追加します
12$newItem = $dom->createElement('item', 'Prepended Item');
13$list->prepend($newItem, 'A text node. ');
14
15$dom->appendChild($list);
16
17// 整形してXMLを出力
18$dom->formatOutput = true;
19echo $dom->saveXML();
20
21?>

DOM\Node|string ...$nodes

• DOM\Node|string ...$nodes: 追加するノードまたはHTML文字列。複数指定可能

void

このメソッドは、指定されたノードを現在の要素の最初の子ノードとして挿入します。処理が成功しても、特別な値を返しません。