変数操作 関数
PHP マニュアル

unset

指定した変数の割当を解除する

説明

void unset(mixed $var, mixed ...$vars)

unset は指定した変数を破棄します。

関数 unset の内部動作は、 破棄しようとする変数の型に依存します。

あるグローバル変数が関数の中で unset された場合、ローカル変数のみが破棄されます。呼出側の環境にある変数は、 unset がコールされる前と同じ値を保持します。 

<?php
function destroy_foo() 
{
    global $foo;
    unset($foo);
}

$foo = 'bar';
destroy_foo();
echo $foo;
?>

上の例の出力は以下となります。

bar

グローバル変数を関数の内部で unset するには、 $GLOBALS 配列を使います。 

<?php
function foo() 
{
    unset($GLOBALS['bar']);
}

$bar = "something";
foo();
?>

参照渡しされた変数が関数内で unset された場合に、 ローカル変数のみが破棄されます。呼出側の環境でその変数は、 unset がコールされる前と同じ値を保持します。 

<?php
function foo(&$bar) 
{
    unset($bar);
    $bar = "blah";
}

$bar = 'something';
echo "$bar\n";

foo($bar);
echo "$bar\n";
?>

上の例の出力は以下となります。

something
something

static変数が関数の内部で unset された場合、 unset は、その関数の残りのコンテキスト内においてのみ 変数を破棄します。関数を再度コールすると、破棄する前の値が復元されます。 

<?php
function foo()
{
    static $bar;
    $bar++;
    echo "Before unset: $bar, ";
    unset($bar);
    $bar = 23;
    echo "after unset: $bar\n";
}

foo();
foo();
foo();
?>

上の例の出力は以下となります。

Before unset: 1, after unset: 23
Before unset: 2, after unset: 23
Before unset: 3, after unset: 23

パラメータ

var

破棄する変数。

vars

別の変数。

戻り値

値を返しません。

例

例1 unset の例

<?php
// 変数を一つ破棄する
unset($foo);

// 配列の要素の一つを破棄する
unset($bar['quux']);

// 複数の変数を破棄する
unset($foo1, $foo2, $foo3);
?>

例2 (unset) によるキャスト

(unset) によるキャストは unset 関数と混同されがちです。 (unset) によるキャストは、 単に NULL 型へのキャストを徹底するだけであり、 キャストした変数の値を書き換えるわけではありません。 (unset) によるキャストは、PHP 7.2.0 で非推奨になり、 PHP 8.0.0 で削除されました。 

<?php
$name = 'Felipe';

var_dump((unset) $name);
var_dump($name);
?>

上の例の出力は以下となります。

NULL
string(6) "Felipe"

注意

注意: これは、関数ではなく 言語構造のため、可変関数 や 名前付き引数 を用いてコールすることはできません。

注意:

現在のコンテキストで見えるものであれば、 オブジェクトのプロパティも破棄することが可能です。

破棄されたプロパティにアクセスする場合、 もし宣言されていれば __get() がコールされます。 破棄されたプロパティに値を設定を設定する場合、 もし宣言されていれば __set() がコールされます。

注意:

オブジェクトのメソッド内で $this を破棄することはできません。

注意:

オブジェクトのアクセス不能なプロパティに対して unset を使用した場合は、もしオーバーロードメソッド __unset() が宣言されていればそれをコールします。

参考