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

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

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

基本的な使い方

『prependメソッドは、DOMElementオブジェクトの最初の子ノードの前に、新しいノードを追加する処理を実行するメソッドです。このメソッドを使用すると、指定した要素のコンテンツの先頭に、他の要素やテキストを簡単に追加できます。引数には、追加したいDOMNodeオブジェクトや文字列を一つ以上指定することが可能です。文字列を渡した場合は、自動的にDOMTextノードとして扱われ、要素内にテキストとして挿入されます。複数の引数を渡すと、それらは指定された順序で要素の先頭に追加されていきます。例えば、引数にノード「A」とノード「B」をこの順で渡すと、要素の先頭は「A」の次に「B」という並びになります。このメソッドは、既存の子ノードをすべて保持したまま、それらの前に新しいコンテンツを挿入したい場合に特に便利です。処理が成功しても戻り値は返しません。

構文(syntax)


1<?php
2
3// DOMDocumentオブジェクトを作成し、HTMLを読み込む
4$doc = new DOMDocument();
5$doc->loadHTML('<html><body><div id="container"><p>既存の段落</p></div></body></html>');
6
7// IDを使って要素を取得する
8$element = $doc->getElementById('container');
9
10// 新しいh1要素を作成
11$newHeading = $doc->createElement('h1', '新しい見出し');
12
13// 取得した要素の先頭に、新しいh1要素とテキストノードを追加する
14$element->prepend($newHeading, '追加されたテキスト ');
15
16// 変更後のHTMLを出力する
17echo $doc->saveHTML();
18
19?>

引数(parameters)

DOMNode|string ...$nodes

DOMNode|string $nodes: 追加するノードまたはHTML文字列。複数指定可能です。

戻り値(return)

DOMElement

このメソッドは、指定されたDOMElementオブジェクト自身を返します。