PHP | ArrayIterator offsetUnset() Function

The ArrayIterator::offsetUnset() function is an inbuilt function in PHP which is used to unset the value for an offset.

Syntax:

void ArrayIterator::offsetUnset( mixed $index )

Parameters: This function accepts single parameter $index which holds the index to unset the offset.

Return Value: This function does not return any value.

Below programs illustrate the ArrayIterator::offsetUnset() function in PHP:

Program 1:

<?php

// Declare an ArrayIterator
$arrItr = new ArrayIterator(
    array(
        "a" => 4,
        "b" => 2,
        "g" => 8,
        "d" => 6,
        "e" => 1,
        "f" => 9
    )
);

// Display the offset value
var_dump($arrItr->offsetGet("a"));

// Unset the offset value
var_dump($arrItr->offsetUnset("a"));

// Display the offset value
var_dump($arrItr->offsetGet("g"));

// Unset the offset value
var_dump($arrItr->offsetUnset("g"));

// Display the offset value
var_dump($arrItr->offsetGet("f"));

// Unset the offset value
var_dump($arrItr->offsetUnset("f"));

?>

Output:

int(4)
NULL
int(8)
NULL
int(9)
NULL

Program 2:

<?php

// Declare an ArrayIterator
$arrItr = new ArrayIterator(
    array(
        "for", "Geeks", "Science",
        "Geeks", "Portal", "Computer"
    )
);


// Print the value at index 1
echo $arrItr->offsetGet(1) . "\n";

// Unset the offset value
var_dump($arrItr->offsetUnset(1));

// Print the value at index 0
echo $arrItr->offsetGet(0) . "\n";

// Unset the offset value
var_dump($arrItr->offsetUnset(0));

// Print the value at index 3
echo $arrItr->offsetGet(3) . "\n";

// Unset the offset value
var_dump($arrItr->offsetUnset(3));

?>

Output:

Geeks
NULL
for
NULL
Geeks
NULL

Reference: https://www.php.net/manual/en/arrayiterator.offsetunset.php