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

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

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

基本的な使い方

『appendメソッドは、既存のDOMElementオブジェクトの子ノードリストの最後に、新たなノードや文字列を追加する処理を実行するメソッドです。このメソッドの主な特徴は、一度の呼び出しで複数のノードや文字列を引数として渡し、まとめて追加できる点にあります。引数には、DOMNodeオブジェクトだけでなく、通常の文字列も直接指定することが可能です。文字列を渡した場合、その文字列を内容とするDOMTextノードが内部で自動的に作成され、対象要素の最後の子ノードとして挿入されます。これにより、テキストノードを別途生成する手間を省くことができます。複数のノードや文字列を追加したい場合は、引数をカンマで区切って渡します。このメソッドは戻り値を返さず、呼び出し元のDOMElementオブジェクトの状態を直接変更します。従来のappendChildメソッドが一度に一つのノードしか追加できなかったのに対し、appendメソッドはより直感的かつ効率的にDOMツリーを構築する手段を提供します。

構文(syntax)


1<?php
2
3// DOMDocumentオブジェクトとルート要素を作成します
4$doc = new DOMDocument('1.0', 'UTF-8');
5$list = $doc->createElement('list');
6
7// list要素に、新しい要素とテキストノードを一度に追加します
8$item1 = $doc->createElement('item', 'Apple');
9$item2 = $doc->createElement('item', 'Orange');
10$list->append($item1, $item2, 'and more fruits...');
11
12$doc->appendChild($list);
13
14// 生成されたXMLを出力します
15echo $doc->saveXML();
16
17/*
18出力結果:
19
20<?xml version="1.0" encoding="UTF-8"?>
21<list><item>Apple</item><item>Orange</item>and more fruits...</list>
22
23*/

引数(parameters)

DOMNode|string ...$nodes

DOMNode|string $nodes: 追加するノードまたは文字列。可変長引数。

戻り値(return)

void

このメソッドは、指定されたノードを現在の要素の末尾に追加します。処理が成功しても、明示的な戻り値はありません。

サンプルコード

DOMElement::append()で子要素を追加する


1<?php
2
3/**
4 * DOMElement::append() メソッドの使用例を示します。
5 * このメソッドは、指定されたDOM要素に新しいノード（DOMNodeオブジェクトまたは文字列）を子として追加します。
6 * 複数のノードや文字列を一度に追加することも可能です。
7 */
8function exampleDOMElementAppend(): void
9{
10    // DOMDocumentのインスタンスを作成し、XMLのバージョンとエンコーディングを指定
11    $dom = new DOMDocument('1.0', 'UTF-8');
12    // 出力されるXMLを見やすくするためにフォーマット設定を有効にする
13    $dom->formatOutput = true;
14
15    // ルート要素を作成し、DOMDocumentオブジェクトの直接の子として追加
16    $rootElement = $dom->createElement('data');
17    $dom->appendChild($rootElement);
18
19    // DOMElement::append() を使用して子要素やテキストを追加する例
20
21    // 1. 文字列を子要素（テキストノード）として追加
22    // append() に文字列を渡すと、それはテキストノードとして既存の要素に追加されます。
23    $rootElement->append('これは最初のテキストコンテンツです。');
24
25    // 2. 既存のDOMNodeオブジェクトを子要素として追加
26    // 新しい <item> 要素を作成し、それを $rootElement の子として追加します。
27    $item1 = $dom->createElement('item', 'アイテム1');
28    $rootElement->append($item1);
29
30    // 3. 複数のDOMNodeオブジェクトや文字列を一度に追加
31    // 可変引数として複数のDOMNodeや文字列を渡すことで、一度に複数のコンテンツを追加できます。
32    $item2 = $dom->createElement('item', 'アイテム2');
33    $description = 'これは追加の説明テキストです。';
34    $subItem = $dom->createElement('subitem', 'サブアイテムコンテンツ');
35    $rootElement->append(
36        $item2,
37        $description, // 文字列も引数として直接渡すことが可能
38        $subItem
39    );
40
41    // 生成されたXMLコンテンツを標準出力
42    echo $dom->saveXML();
43}
44
45// サンプル関数を実行して結果を表示
46exampleDOMElementAppend();
47

PHPのDOMElement::append()メソッドは、XMLやHTMLなどのDOM（Document Object Model）構造を扱う際に、特定のDOM要素（DOMElement）に対して新しい子ノードを追加するための機能です。このメソッドは、引数としてDOMNodeオブジェクトまたは文字列を一つ、あるいは複数受け取ることができます。文字列が渡された場合、それは自動的にテキストノードとして要素に追加されます。DOMNodeオブジェクトが渡された場合は、そのオブジェクト自体が子要素として追加されます。複数の引数を指定することで、一度に複数の要素やテキストコンテンツを親要素の最後に追加できる点が特徴です。戻り値はvoidであり、何も返しませんが、指定されたDOM要素の状態が変更されます。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、dataというルート要素を追加しています。次に、このdata要素に対してappend()メソッドを使い、様々な方法で子ノードを追加しています。最初の例では、文字列を直接渡してテキストコンテンツを追加し、次にitemというDOMElementオブジェクトを追加しています。さらに、複数のDOMElementオブジェクトと文字列を一度にappend()に渡すことで、効率的に複数の子要素を追加できることを示しています。このように、append()を使用することで、柔軟かつ直感的にDOMツリーを構築・操作することが可能になります。

この DOMElement::append() メソッドは、XMLやHTMLなどのドキュメント構造をプログラムで操作する DOMElement クラスの機能です。PHPの配列に要素を追加する通常の array_push や [] などの操作とは全く異なり、DOMツリーにノードを追加します。引数には DOMNode オブジェクトまたは文字列のみを指定でき、複数の要素を一度に追加できる点が便利です。文字列は自動的にテキストノードとして扱われます。このメソッドは何も返さない (void) ため、実行結果を変数に代入する意味はありません。通常の配列操作と混同せず、DOMの文脈で利用することを理解してください。