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

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

作成日: 更新日:

基本的な使い方

『prependメソッドは、DOMDocumentFragmentオブジェクトの最初の子ノードの前に、新しいノードや文字列を挿入するために使用されるメソッドです。このメソッドを呼び出すと、引数として渡された1つ以上のDOMNodeオブジェクトまたは文字列が、対象となるDOMDocumentFragmentの既存の子ノードリストの先頭に追加されます。引数に文字列を指定した場合は、その文字列を含む新しいDOMTextノードが自動的に作成されて挿入されます。複数の要素を一度に追加したい場合、引数をカンマで区切って渡すことができ、それらは指定された順序で先頭に挿入されます。この機能により、文書の断片の先頭に動的にコンテンツを効率良く追加することが可能になります。例えば、リストの先頭に新しい項目を追加したり、セクションの冒頭に注意書きを挿入したりする操作を簡単に行えます。このメソッドには戻り値はありません。

構文(syntax)

1<?php
2
3// DOMDocument と DOMDocumentFragment のインスタンスを作成します
4$doc = new DOMDocument();
5$fragment = $doc->createDocumentFragment();
6
7// フラグメントに基準となる要素を追加します
8$p = $doc->createElement('p', '既存の要素');
9$fragment->append($p);
10
11// フラグメントの先頭に追加したい要素やテキストを作成します
12$h1 = $doc->createElement('h1', '新しい見出し');
13$text = '追加のテキストです。';
14
15// prepend() を使って、フラグメントの先頭にノードや文字列を追加します
16$fragment->prepend($h1, $text);
17
18// 結果を確認するためにXMLとして出力します
19// 出力: <h1>新しい見出し</h1>追加のテキストです。<p>既存の要素</p>
20echo $doc->saveXML($fragment);
21
22?>

引数(parameters)

DOMNode|string ...$nodes

  • DOMNode|string ...$nodes: 追加したいノードまたはHTML文字列のリスト

戻り値(return)

void

このメソッドは、DOMDocumentFragmentの先頭にノードを追加します。戻り値はありません。

【PHP8.x】prependメソッドの使い方 | いっしー@Webエンジニア