【PHP】配列の最後に要素を追加できるarray_push関数を解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。

この記事では、 PHPで配列の最後に要素を追加することができるarray_push関数について

array_push関数とは
array_push関数を使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
array_push関数とは
array_push関数を解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：array_push関数を使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows10
PHPのバージョン	8.0.3
XAMPPのバージョン	8.0.3

PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。

【XAMPP】インストールするやり方を解説します

array_push関数とは

array_push関数とは、指定された配列の最後に設定されている値をすべて追加し、追加後の配列の要素数を返す関数です。
追加したい要素はいくつでも設定できます。

使い方サンプルは下記になります。

$sample = ['aaa', 'bbb', 'ccc'];
$result = array_push($sample, 'xxx', 'yyy', 'zzz');

1 2	$sample = ['aaa', 'bbb', 'ccc']; $result = array_push($sample, 'xxx', 'yyy', 'zzz');

上記の例だと、変数resultには「6」が返され、変数sampleは

Array
(
    [0] => aaa
    [1] => bbb
    [2] => ccc
    [3] => xxx
    [4] => yyy
    [5] => zzz
)

Array

(

[0] => aaa

[1] => bbb

[2] => ccc

[3] => xxx

[4] => yyy

[5] => zzz

)

という配列になっています。

array_push関数の注意点として、連想配列に対して要素追加はできますが、連想配列の要素を追加することができない、という点です。

どういうことかと言いますと

$sample = ['A' => 'aaa', 'B' => 'bbb',  'c' => 'ccc'];
$result = array_push($sample, 'X' => 'xxx',  'Y' => 'yyy',  'Z' => 'zzz');

1 2	$sample = ['A' => 'aaa', 'B' => 'bbb', 'c' => 'ccc']; $result = array_push($sample, 'X' => 'xxx', 'Y' => 'yyy', 'Z' => 'zzz');

上記のようには書くことができない、ということです。
実行すると

Parse error: syntax error, unexpected token "=>", expecting ")" in 【プログラム】 on line ○○

1	Parse error: syntax error, unexpected token "=>", expecting ")" in 【プログラム】 on line ○○

というエラーになります。

では、次の章で実際に使ってみます。

array_push関数を解説するプログラムの概要

array_push関数を解説するプログラムでは、配列にarray_push関数を使って

配列
連想配列

の2種類の配列に要素を追加します。
要素の追加前後で配列がどうなっているのかを表示し中身を確認します。

phpプログラムは

C:\xampp\htdocs

配下に、【arraypushsample.php】というファイル名で格納しています。

PHPサンプルプログラム

<?php
	print('■array_push関数サンプル<br /><br />');
	
	print('・パターン1：配列に要素を追加<br />');
	$fish_array = ['タイ', 'マグロ', 'スズキ'];
	print('要素を追加するの配列<br />');
	print('<pre>');
	print_r($fish_array);
	print('</pre>');

	$fish_result = array_push($fish_array, 'ブリ', 'カンパチ');
	print('返り値:'.$fish_result.'<br />');
	print('要素を追加した後の配列<br />');
	print('<pre>');
	print_r($fish_array);
	print('</pre>');

	print('・パターン2：連想配列に要素を追加<br />');
	$fruit_array = ['apple' => 'リンゴ', 'orange' => 'オレンジ'];
	print('要素を追加するの配列<br />');
	print('<pre>');
	print_r($fruit_array);
	print('</pre>');

	$fruit_result = array_push($fruit_array, 'バナナ', 'メロン', 'パイナップル', 'ブドウ');
	print('返り値:'.$fruit_result.'<br />');
	print('要素を追加した後の配列<br />');
	print('<pre>');
	print_r($fruit_array);
	print('</pre>');
?>

<?php

print('■array_push関数サンプル ');

print('・パターン1：配列に要素を追加 ');

$fish_array = ['タイ', 'マグロ', 'スズキ'];

print('要素を追加するの配列 ');

print('<pre>');

print_r($fish_array);

print('</pre>');

$fish_result = array_push($fish_array, 'ブリ', 'カンパチ');

print('返り値:'.$fish_result.' ');

print('要素を追加した後の配列 ');

print('<pre>');

print_r($fish_array);

print('</pre>');

print('・パターン2：連想配列に要素を追加 ');

$fruit_array = ['apple' => 'リンゴ', 'orange' => 'オレンジ'];

print('要素を追加するの配列 ');

print('<pre>');

print_r($fruit_array);

print('</pre>');

$fruit_result = array_push($fruit_array, 'バナナ', 'メロン', 'パイナップル', 'ブドウ');

print('返り値:'.$fruit_result.' ');

print('要素を追加した後の配列 ');

print('<pre>');

print_r($fruit_array);

print('</pre>');

実行結果

XAMPPを起動して、【http://localhost/arraypushsample.php】のURLにアクセスします。

XAMPPでPHPの動かし方については、こちらの記事をご参考ください。

XAMPPでPHPの動かし方を解説します

PHPのarray_push関数を解説

配列の最後に指定した要素が追加されていることを確認できました。

まとめ：array_push関数を使ってみよう！

以上がarray_push関数についての解説でした。

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ