PHP unset() Function
The unset() function is used to destroy the given variable.
PHP Version Requirements: PHP 4, PHP 5, PHP 7
Syntax
void unset ( mixed $var [, mixed $... ] )
Parameter Description:
- $var: The variable to be destroyed.
Return Value
No return value.
Examples
<?php
// Destroy a single variable
unset ($foo);
// Destroy a single array element
unset ($bar['quux']);
// Destroy multiple variables
unset($foo1, $foo2, $foo3);
?>
If you unset() a global variable inside a function, only the local variable is destroyed, and the variable in the calling environment will retain its value before the unset() call.
<?php
function destroy_foo() {
global $foo;
unset($foo);
}
$foo = 'bar';
destroy_foo();
echo $foo;
?>
Output:
bar
If you want to unset() a global variable inside a function, you can use the $GLOBALS array to achieve this:
<?php
function foo()
{
unset($GLOBALS['bar']);
}
$bar = "something";
foo();
?>
If you unset() a variable passed by reference in a function, only the local variable is destroyed, and the variable in the calling environment will retain its value before the unset() call.
<?php
function foo(&$bar) {
unset($bar);
$bar = "blah";
}
$bar = 'something';
echo "$bar\n";
foo($bar);
echo "$bar\n";
?>
Output:
something
something
If you unset() a static variable inside a function, it will be destroyed within the function. However, when the function is called again, the static variable will be restored to its value before it was destroyed.
<?php
function foo()
{
static $bar;
$bar++;
echo "Before unset: $bar, ";
unset($bar);
$bar = 23;
echo "after unset: $bar\n";
}
foo();
foo();
foo();
?>
Output:
Before unset: 1, after unset: 23
Before unset: 2, after unset: 23
Before unset: 3, after unset: 23