【PHP】指定した変数名から配列を作成するcompact関数を解説します

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

この記事では、 PHPで指定した変数名から配列を作成するcompact関数について

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

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

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

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

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

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

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

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

compact関数とは

compact関数とは、引数に指定した変数名をキー、その変数の値を値とする連想配列を作成して返す関数です。
compact関数には複数の値を指定することができます。
使い方サンプルは以下です。

$sample = 'サンプル';
$test = 'テスト';
$result = compact('sample', 'test');

$sample = 'サンプル';

$test = 'テスト';

$result = compact('sample', 'test');

上記の例だと、変数resultには

Array
(
    [sample] => サンプル
    [test] => テスト
)

Array

(

[sample] => サンプル

[test] => テスト

)

という連想配列が返されます。

注意点として、宣言していない変数名をcompact関数の引数に設定した場合エラーとなることです。
たとえば

$sample = 'サンプル';
$test = 'テスト';
$result = compact('sample', 'error');

$sample = 'サンプル';

$test = 'テスト';

$result = compact('sample', 'error');

と宣言していない変数名をcompact関数に指定して実行した場合
PHPのcompact関数を解説

Warning: compact(): Undefined variable ○○

1	Warning: compact(): Undefined variable ○○

というエラーになります。
この宣言していない場合エラーとなる仕様は、PHPのバージョン7.3.0からです。
それ以前のバージョンでは、スキップされます。

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

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

compact関数を解説するプログラムでは、変数を3つ宣言し、compact関数に渡して連想配列を作成します。
戻り値がどのようになっているのかを表示させます。

phpプログラムは

C:\xampp\htdocs

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

PHPサンプルプログラム

<?php
	print('■compact関数サンプル<br />');

	$name = '田中';
	$age = 28;
	$job = 'システムエンジニア';

	$user = compact('name', 'age', 'job');
	print_r('<pre>');
	print_r($user);
	print_r('</pre>');
?>

<?php

print('■compact関数サンプル<br />');

$name = '田中';

$age = 28;

$job = 'システムエンジニア';

$user = compact('name', 'age', 'job');

print_r('<pre>');

print_r($user);

print_r('</pre>');

実行結果

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

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

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

PHPのcompact関数を解説

指定した通り、連想配列を作成されていることが確認できました。

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

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

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