定義と使用方法

PHPバージョン
4+

array_push()関数は、配列の末尾に1つ以上の要素を追加（push、後ろから押し込む）ための関数です。

特徴

  • 配列の末尾に新しい要素を1つ以上追加します。
  • 新しい配列を返さず、元の配列自体を直接変更します。
  • このとき、追加された要素の分だけ配列の長さも増加します。
  • 追加後の配列の長さを整数で返します。

基本の例

PHP 
$array = [1, 2, 3];

// 配列の末尾に1つの要素を追加します。
array_push($array, 4);
print_r($array);
/*
出力:
    Array
    (
        [0] => 1
        [1] => 2
        [2] => 3
        [3] => 4
    )
*/

// 配列の末尾に複数の要素を追加します。
array_push($array, 5, 6, 7);
print_r($array);
/*
出力:
    Array
    (
        [0] => 1
        [1] => 2
        [2] => 3
        [3] => 4
        [4] => 5
        [5] => 6
        [6] => 7
    )
*/

array_unshift()関数はこれと似ていますが、配列の先頭に1つ以上の新しい要素を追加します。

構文

PHP 
array_push(array &$array, mixed $value1 [, mixed $value2 [, mixed $... ]]): int

引数

array_push()関数の引数
&$array 要素を追加する対象の配列（参照変数）です。
$value1, $value2, $... 配列の末尾に追加する要素です。配列に追加する1つ以上の値を指定できます。

戻り値

返り値は、配列に要素が追加された後の総要素数を示します。この値は整数（例：1、2、3、…）として返されます。

PHP 
$array = [1, 2, 3];

// 配列の末尾に1つの要素を追加し、返り値を保存
$totalElements = array_push($array, 4);
print_r($array);
/*
出力:
    Array
    (
        [0] => 1
        [1] => 2
        [2] => 3
        [3] => 4
    )
*/

echo "配列に追加された要素の総数: " . $totalElements; // 出力: 配列に追加された要素の総数: 4

活用例

次はarray_push()関数を使用した例です。

複数の要素を追加するには

複数の要素を追加するには、array_push()関数に追加したい要素をカンマ（,）で区切って順番に列挙します。

PHP 
$fruits = ['apple', 'banana', 'cherry'];

// 配列の末尾に要素を追加
array_push($fruits, 'date', 'elderberry');

// 配列の内容を確認
print_r($fruits);
/*
出力:
    Array
    (
        [0] => apple
        [1] => banana
        [2] => cherry
        [3] => date
        [4] => elderberry
    )
*/

array_push()関数の代わりに、配列の代入演算子[]を使用することもできます。

array_push()関数の代わりに、配列の代入演算子[]を使用して要素を追加することも可能です。上記の例は、次のように配列代入演算子で書き換えることができます。

PHP 
$fruits = ['apple', 'banana', 'cherry'];

// 配列の末尾に要素を追加
$fruits[] = 'date';
$fruits[] = 'elderberry';

// 配列の内容を確認
print_r($fruits);
/*
出力:
    Array
    (
        [0] => apple
        [1] => banana
        [2] => cherry
        [3] => date
        [4] => elderberry
    )
*/

どちらの方法も配列の末尾に要素を追加するために使用できます。どの方法を選ぶかは、開発者の好みによります。

array_push()関数を連想配列に使用しない

連想配列は、PHPでキーと値のペアでデータを格納する強力なデータ構造です。しかし、場合によっては連想配列に新しいデータを追加する必要があります。このような状況でarray_push()関数を使用できるでしょうか。array_push()関数と連想配列を組み合わせて使用することの効率性と代替手段について考えてみましょう。

連想配列との不一致

連想配列は各要素に固有のキーを持つため、array_push()関数の使用は連想配列には適していません。array_push()関数は配列の末尾に要素を追加する関数であり、キーと値のペアを指定する用途には向いていません。

連想配列にデータを追加する

連想配列にデータを追加する際は、次のような方法を使用します。

PHP - 連想配列に使用しない 
$person = array(
    'first_name' => 'John',
    'last_name' => 'Doe',
    'age' => 30
);

// 連想配列にキーと値をarray_push()関数で追加
array_push($person, 'email', 'john@example.com', 'city', 'New York');

// 連想配列の内容を確認
print_r($person);
/*
出力:
    Array
    (
        [first_name] => John
        [last_name] => Doe
        [age] => 30
        
        // この部分から不要な連想配列のキー（0、1、2、3のインデックスのみ割り当て）と値です。
        [0] => email
        [1] => john@example.com
        [2] => city
        [3] => New York
    )
*/

この例では、array_push()関数を使用して連想配列にキーと値を追加しましたが、この方法はあまり一般的ではなく、推奨されません。なぜなら、array_push()関数を使用すると、キーはインデックスとしてのみ割り当てられるからです。

array_push()関数を使用して、与えられた連想配列に新しいキーと値のペアを直接追加することはできません。

連想配列にキーと値のペアを追加するには、直接キーを指定して値を代入する必要があります。
例えば、与えられた例を次のように記述できます。

PHP 
$person = array(
    'first_name' => 'John',
    'last_name' => 'Doe',
    'age' => 30
);

// 連想配列に 'address' キーと値を直接代入
$person['address'] = 'Tokyo, Japan';

// 連想配列の内容を確認
print_r($person);
/*
出力:
    Array
    (
        [first_name] => John
        [last_name] => Doe
        [age] => 30
        [address] => Tokyo, Japan
    )
*/

このように直接キーと値のペアを代入することが、連想配列に新しいデータを追加する一般的な方法です。

結論

array_push()関数は主に通常の配列に使用され、連想配列には効果的に機能しません。連想配列にデータを追加する場合は、直接キーと値のペアを指定するのが一般的であり、データの管理や検索をより容易にします。したがって、連想配列と通常の配列はそれぞれ異なる目的と使用ケースを持っており、データ構造を選択する際にはこれらの違いを考慮する必要があります。

参考資料

関連項目