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

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

作成日: 更新日:

基本的な使い方

『appendメソッドは、ArrayIteratorオブジェクトが扱う配列の末尾に、新しい要素を追加するために使用されるメソッドです。ArrayIteratorは、配列をオブジェクトのように扱い、foreachループなどで繰り返し処理(イテレーション)を可能にするためのクラスです。このappendメソッドを呼び出すと、引数として指定した値が、イテレータの内部で管理されている配列の最後の要素として追加されます。例えば、$iterator = new ArrayIterator(['apple', 'banana']); というオブジェクトに対して $iterator->append('cherry'); を実行すると、イテレータが指す配列は ['apple', 'banana', 'cherry'] へと変更されます。このメソッドは、元のデータ構造を直接変更する破壊的な操作であり、返り値はありません(void)。ループ処理の途中で動的に要素を追加したい場合など、イテレーションを行いながらコレクションの内容を末尾に拡張する必要がある際に特に役立ちます。通常の配列に要素を追加する array_push() 関数や $array[] = $value; という構文と似た役割を、ArrayIteratorオブジェクトに対して提供します。

構文(syntax)

1<?php
2
3$array = ['apple', 'banana'];
4$iterator = new ArrayIterator($array);
5
6// イテレータの末尾に 'cherry' を追加します
7$iterator->append('cherry');
8
9foreach ($iterator as $fruit) {
10    echo $fruit . PHP_EOL;
11}
12
13?>

引数(parameters)

mixed $value

  • mixed $value: 追加する値を指定します。

戻り値(return)

戻り値なし

戻り値はありません