unset

(PHP 4, PHP 5, PHP 7, PHP 8)

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

説明

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

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

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

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

例1 unset() の使用例

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

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

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

例2 グローバル変数と unset()

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

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

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

例3 unset() とと参照

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

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

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

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

例4 static 変数と unset()

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

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

パラメータ

var: 破棄する変数。
vars: 別の変数。

戻り値

値を返しません。

例

例5 unset() の例

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

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

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

注意

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

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

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

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

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

参考

isset() - 変数が宣言されていること、そして null とは異なることを検査する
empty() - 変数が空であるかどうかを検査する
__unset()
array_splice() - 配列の一部を削除し、他の要素で置換する
(unset) casting