【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オブジェクト自身を返します。

サンプルコード

DOMElement::prependで子ノードを先頭に追加する


1<?php
2
3/**
4 * DOMElement::prepend() メソッドの使用例。
5 * このメソッドは、指定されたノードまたは文字列を、現在のDOMElementの子ノードの先頭に追加します。
6 * キーワードの「php prepend to array」と直接的な関係はありませんが、
7 * DOMElement::prepend() はDOMツリーの「先頭に追加する」機能を提供します。
8 */
9function exampleDomElementPrepend(): void
10{
11    // 1. 新しいDOMDocumentを作成します。
12    // '1.0' はXMLのバージョン、'UTF-8' はエンコーディングです。
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力時にXMLを整形する設定
15    $dom->formatOutput = true;
16
17    // 2. ルート要素 'root' を作成し、DOMDocumentに追加します。
18    $rootElement = $dom->createElement('root');
19    $dom->appendChild($rootElement);
20
21    // 3. いくつかの要素を子ノードとして追加します。
22    // これらは後でprependされるノードの後になります。
23    $itemElement2 = $dom->createElement('item', 'Existing Item 2');
24    $rootElement->appendChild($itemElement2);
25
26    $itemElement3 = $dom->createElement('item', 'Existing Item 3');
27    $rootElement->appendChild($itemElement3);
28
29    // 4. 新しく追加したい要素 'item' を作成します。
30    $itemElement1 = $dom->createElement('item', 'New Item 1 (prepended node)');
31
32    // 5. DOMElement::prepend() メソッドを使用して、$rootElement の子ノードの先頭に $itemElement1 を追加します。
33    // 複数のノードや文字列を一度に追加することも可能です。
34    // このメソッドは、操作されたDOMElement自身を返します。
35    $rootElement->prepend($itemElement1);
36
37    // 6. 文字列を直接prependすることもできます。
38    // この文字列はテキストノードとして追加されます。
39    $rootElement->prepend('テキストノードとして追加されました。 ');
40
41    // 7. 最終的なDOMツリーをHTML形式で出力します。
42    // prependされた要素が先頭に追加されていることを確認できます。
43    echo "--- prepend後のDOMツリー ---" . PHP_EOL;
44    echo $dom->saveHTML();
45}
46
47// 関数の実行
48exampleDomElementPrepend();

PHP 8のDOMElement::prepend()メソッドは、XMLやHTMLなどのDOMツリーを操作する際に、特定の要素（DOMElement）の子ノードの先頭に、新しいノードやテキストを追加するために利用されます。このメソッドは、引数として複数のDOMNodeオブジェクト、または文字列を受け取ることができ、文字列を渡すとそれがテキストノードとして要素の先頭に追加されます。メソッドは操作を行ったDOMElementオブジェクト自身を返します。

サンプルコードでは、まず新しいDOMDocumentとルート要素を作成し、いくつかの既存の子要素を追加します。その後、$rootElementに対しprepend()メソッドを使って、新しく作成した要素$itemElement1を子ノードの先頭に挿入しています。さらに、文字列を直接prepend()することで、それがテキストノードとして先頭に追加される様子も示しています。これにより、最終的なDOMツリーでは、新しく追加された要素やテキストが他の既存の子要素よりも前に配置されていることが確認できます。

このメソッドは「php prepend to array」というキーワードとは直接関係がなく、配列操作ではなくDOMツリーの構造においてノードを先頭に追加する機能を提供します。

DOMElement::prepend()メソッドは、「php prepend to array」というキーワードから連想されやすい配列の操作とは異なり、HTMLやXMLなどのDOMツリーにおいて、現在のDOM要素の先頭に子ノードを追加する際に利用します。引数にはDOMNodeオブジェクトまたは文字列を複数指定でき、文字列を渡すとテキストノードとして挿入されますのでご注意ください。戻り値は操作を行ったDOMElementオブジェクト自身ですので、メソッドチェーンなどに活用できます。DOMツリーの構造を考慮し、他の要素との関係性を理解した上で正しくご利用ください。

PHP DOMElement prepend で文字列を追加する


1<?php
2
3// DOMDocument を作成し、HTML5互換モードで初期化します。
4$dom = new DOMDocument('1.0', 'UTF-8');
5// HTMLの標準に準拠するため、HTML5モードを有効にします。
6$dom->loadHTML('<!DOCTYPE html><html><body></body></html>');
7
8// body要素を取得します。
9$body = $dom->getElementsByTagName('body')->item(0);
10
11// <p>要素を作成し、初期テキストを追加します。
12$paragraph = $dom->createElement('p', 'This is the original text.');
13
14// body要素に<p>要素を追加します。
15$body->appendChild($paragraph);
16
17// DOMElement::prepend() メソッドを使用して、<p>要素の先頭に新しい文字列を追加します。
18// 引数に直接文字列を渡すことで、テキストノードとして追加されます。
19$paragraph->prepend('Prepended text. ');
20
21// DOMDocument の内容をHTMLとして出力します。
22// この出力により、新しく追加された文字列が元の文字列の前に表示されることを確認できます。
23echo $dom->saveHTML();
24
25?>

PHPのDOMElement::prependメソッドは、HTMLなどのXMLドキュメントの構造を操作するDOM（Document Object Model）において、特定の要素の先頭に新しいコンテンツを追加するための機能です。既存の子要素やテキストノードの前に、新しい情報を挿入したい場合に利用します。

サンプルコードでは、まずDOMDocumentを作成し、基本的なHTMLの骨組みを用意しています。その後、<body>要素を取得し、「This is the original text.」というテキストを含む要素を作成して<body>に追加しています。

$paragraph->prepend('Prepended text. ');という行が、このメソッドの具体的な使用例です。ここでは、先ほど作成した要素（$paragraph）の既存のテキストコンテンツの先頭に、「Prepended text. 」という新しい文字列を追加しています。このメソッドの引数には、追加したいDOMNodeオブジェクト、または文字列を複数指定することができます。文字列を渡すと、それは自動的にテキストノードとして要素の先頭に挿入されます。

prependメソッドの戻り値は、操作が行われたDOMElementオブジェクト自身です。これにより、メソッドチェーンを用いて続けて他のDOM操作を行うことも可能です。最終的にecho $dom->saveHTML();で出力される結果を見ると、元のテキストの前に新しい文字列が追加され、「Prepended text. This is the original text.」という形で表示されていることが確認できます。この機能は、動的にWebページの表示内容を更新する際に役立ちます。

このDOMElement::prepend()メソッドは、HTMLやXML文書の内部構造（DOMツリー）を操作する機能であり、PHPの通常の文字列変数を直接加工するものではない点にご注意ください。引数に文字列を渡すと、それは自動的に新しいテキストノードとして、指定したDOM要素の先頭に挿入されます。例えば、要素に'強調'という文字列をprependした場合、強調という文字列がそのままテキストとして表示され、HTMLタグとして解釈されるわけではありません。文書の構造を壊さないよう、DOM操作の基本的な原則を理解した上で利用することが重要です。