【PHP】指定した変数の割当を削除できるunset関数を解説します

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

この記事では、 PHPで指定した変数の割当を削除することができるunset関数について

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

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

前提条件：実行環境について
unset関数とは
1. パターン1：変数を指定
2. パターン2：配列の要素を指定
unset関数を解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：unset関数を使ってみよう！

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

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

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

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

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

unset関数とは

unset関数とは、引数に指定した変数や配列の特定の要素の割当を削除することができる関数です。
引数には複数指定することができ、返り値はありません。

unset関数は引数に

変数を指定
配列の要素を指定

の合計2パターンの使い方があります。
それぞれ解説します。

パターン1：変数を指定

変数を指定した場合は、変数が削除されます。
使い方サンプルは、以下になります。

$sample = 'sample';
unset($sample);

1 2	$sample = 'sample'; unset($sample);

実行後に変数sampleは使うことができません。
もし呼び出そうとした場合、

Warning: Undefined variable $sample in 【ファイル名】 on line 〇〇

1	Warning: Undefined variable $sample in 【ファイル名】 on line 〇〇

というエラーが発生されます。

パターン2：配列の要素を指定

配列の要素を指定した場合は、配列から引数に指定した要素が削除されます。
使い方サンプルは、以下になります。

$sample = ['aa', 'bb', 'cc'];
unset($sample[1]);

1 2	$sample = ['aa', 'bb', 'cc']; unset($sample[1]);

unset関数実行前は

Array
(
    [0] => aa
    [1] => bb
    [2] => cc
)

Array

(

[0] => aa

[1] => bb

[2] => cc

)

という配列だったのが、実行後は引数に指定された要素が削除され

Array
(
    [0] => aa
    [2] => cc
)

Array

(

[0] => aa

[2] => cc

)

という配列になります。

解説のために

変数を指定
配列の要素を指定

と章を分けましたが、以下のように変数と配列をごちゃまぜで指定することもできます。

$sample = ['aa', 'bb', 'cc'];
$test = 'test';
unset($sample[1], $test);

$sample = ['aa', 'bb', 'cc'];

$test = 'test';

unset($sample[1], $test);

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

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

unset関数を解説するプログラムでは、

変数を指定
配列の要素を指定

の2パターンで動作を確認します。
unset関数の実行前後でどうなっているかを表示して確認します。
phpプログラムは

C:\xampp\htdocs

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

PHPサンプルプログラム

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

	print('・パターン1：変数を指定<br />');
	$orange = 'オレンジ';
	print('unset関数実行前：');
	if(isset($orange)){
		print('変数orangeは存在する<br />');
	}else{
		print('変数orangeは存在しない<br />');
	}

	unset($orange);
	print('unset関数実行後：');
	if(isset($orange)){
		print('変数orangeは存在する<br />');
	}else{
		print('変数orangeは存在しない<br />');
	}
	print('<br />');

	// 配列の要素を削除した場合
	print('・パターン2：配列の要素を指定<br />');
	$fish_array = array('マグロ', 'サケ', 'アユ', 'タイ');
	print('unset関数実行前');
	print_r('<pre>');
	print_r($fish_array);
	print_r('</pre>');

	unset($fish_array[1], $fish_array[3]);
	print('unset関数実行後');
	print_r('<pre>');
	print_r($fish_array);
	print_r('</pre>');
	print('<br ><br >');
?>

<?php

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

print('・パターン1：変数を指定 ');

$orange = 'オレンジ';

print('unset関数実行前：');

if(isset($orange)){

print('変数orangeは存在する ');

}else{

print('変数orangeは存在しない ');

}

unset($orange);

print('unset関数実行後：');

if(isset($orange)){

print('変数orangeは存在する ');

}else{

print('変数orangeは存在しない ');

}

print(' ');

// 配列の要素を削除した場合

print('・パターン2：配列の要素を指定 ');

$fish_array = array('マグロ', 'サケ', 'アユ', 'タイ');

print('unset関数実行前');

print_r('<pre>');

print_r($fish_array);

print_r('</pre>');

unset($fish_array[1], $fish_array[3]);

print('unset関数実行後');

print_r('<pre>');

print_r($fish_array);

print_r('</pre>');

print(' ');

isset関数とarray関数についてはこちらの記事をご参考ください。

isset関数
【PHP】変数が宣言されているかを確認できるisset関数を解説します

array関数
【PHP】配列を初期化できるarray関数を解説します

実行結果

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

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

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

PHPのunset関数を解説

指定した変数および配列の要素が削除できていることを確認できました。

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

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

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