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

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

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

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

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

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

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

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

OS	Windows10
PHPのバージョン	7.4.6

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

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

array_push関数とは

array_push関数とは、指定された配列の最後に要素を追加し、追加した後の要素数を返す関数です。
引数は以下のように指定します。

第一引数（必須）	第二引数以降に指定した引数を最後に追加したい配列
第二引数以降（任意）	追加したい要素

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

上記の例だとresultには4が返され、sample_arrayは引数で指定された’sample’と’hogehoge’が追加された

Array
(
[0] => test
[1] => hoge
[2] => sample
[3] => hogehoge
)

という中身になっています。

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

たとえば

$sample_array = ['test'=>'テスト', 'hoge'=>'ほげ'];
$result_sample = array_push($sample_array, 'hogehoge'=>'ほげほげ');

1 2	$sample_array = ['test'=>'テスト', 'hoge'=>'ほげ']; $result_sample = array_push($sample_array, 'hogehoge'=>'ほげほげ');

という引数を指定した場合

Parse error: syntax error, unexpected ‘=>’ (T_DOUBLE_ARROW), expecting ‘)’

というエラーメッセージが表示されます。
引数に指定するものは、文字列などを指定しましょう。

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

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

array_push関数を解説するプログラムでは、配列にarray_push関数を使って要素を追加します。
要素の追加前後で配列がどうなっているのかを表示し中身を確認します。

phpプログラムは

C:\xampp\htdocs

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

PHPサンプルプログラム

<?php
	$fish_array = ['タイ', 'マグロ', 'スズキ'];
	print('・要素を追加する前<br />');
	print_r('<pre>');
	print_r($fish_array);
	print_r('</pre>');

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

<?php

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

print('・要素を追加する前<br />');

print_r('<pre>');

print_r($fish_array);

print_r('</pre>');

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

print('・要素を追加した後<br />');

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

print_r('<pre>');

print_r($fish_array);

print_r('</pre>');

実行結果

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

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

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

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

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

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

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