Remover elemento de array no PHP: unset e array_splice

Para remover um elemento de um array PHP pela chave, use unset($array[$key]). O elemento some, as outras chaves continuam exatamente como estavam, e aplicar unset numa chave que não existe não é erro.

<?php
$user = ["name" => "Ada", "email" => "ada@example.com", "password" => "secret"];

unset($user["password"]);
print_r($user);

$colors = ["red", "green", "blue", "yellow"];
unset($colors[1]);
print_r($colors);

Olhe o segundo resultado: as chaves agora são 0, 2, 3. O unset nunca renumera.

Reindexar o array depois do unset

Uma lista com buraco nas chaves causa problemas depois: um loop for ($i = 0; ...) encontra o índice ausente, e o json_encode escreve um objeto JSON em vez de um array. O array_values() devolve chaves limpas.

<?php
$colors = ["red", "green", "blue", "yellow"];
unset($colors[1]);

echo json_encode($colors), "\n";

$colors = array_values($colors);
echo json_encode($colors), "\n";

Remover pela posição com array_splice

array_splice($array, $offset, $length) remove $length elementos a partir da posição $offset, renumera as chaves e retorna o que removeu. Um offset negativo conta a partir do fim. Ele também pode inserir elementos de substituição na mesma chamada.

<?php
$queue = ["a", "b", "c", "d", "e"];

$removed = array_splice($queue, 1, 2);
print_r($removed);
print_r($queue);

// Remove the second to last element
array_splice($queue, -2, 1);
print_r($queue);

// Replace one element with two
$letters = ["x", "y", "z"];
array_splice($letters, 1, 1, ["Y1", "Y2"]);
print_r($letters);

O array_splice trabalha com posições, não com chaves: num array associativo ele remove pelo lugar na ordem e mantém as chaves string. A página sobre array_slice o compara com o array_slice, que copia uma parte sem alterar o original.

Remover um elemento pelo valor

array_diff($array, [$value]) retorna o array sem todos os elementos iguais a $value, mantendo as chaves do resto. Para remover só a primeira correspondência, encontre a chave com array_search e aplique unset.

<?php
$tags = ["php", "draft", "arrays", "draft", "tips"];

// Every "draft"
print_r(array_diff($tags, ["draft"]));

// Several values at once
print_r(array_values(array_diff($tags, ["draft", "tips"])));

// Only the first "draft"
$key = array_search("draft", $tags);
if ($key !== false) {
    unset($tags[$key]);
}
print_r($tags);

O array_diff compara valores como strings, então array_diff([1, "1", 2], [1]) remove tanto o inteiro quanto a string. Quando a condição é mais que "igual a este valor", use o array_filter com um callback.

Remover o primeiro ou o último elemento

array_shift() remove o primeiro elemento e array_pop() remove o último. Os dois retornam o elemento removido, o que os torna práticos para filas e pilhas.

<?php
$tasks = ["write", "test", "deploy"];

$first = array_shift($tasks);
$last = array_pop($tasks);

echo "First: $first\n";
echo "Last: $last\n";
print_r($tasks);

O array_shift renumera as chaves numéricas a partir de 0. O array_pop não precisa, já que o buraco fica no fim.

Remover várias chaves de uma vez

O unset aceita vários elementos numa chamada. Para remover uma lista de chaves que está num array, inverta-a com array_flip() para que os nomes virem chaves, e passe-a para o array_diff_key().

<?php
$row = ["id" => 7, "name" => "Ada", "token" => "x1", "salt" => "y2", "role" => "admin"];

$copy = $row;
unset($copy["token"], $copy["salt"]);
print_r($copy);

$hidden = ["token", "salt", "role"];
print_r(array_diff_key($row, array_flip($hidden)));

Erro comum: unset com array_search quando o valor não existe

O array_search retorna false quando não encontra nada, e false usado como chave de array vira 0. Então esta linha apaga o primeiro elemento sempre que o valor não está no array:

<?php
$fruits = ["apple", "banana", "cherry"];

// "grape" is not there, array_search returns false, false becomes key 0
unset($fruits[array_search("grape", $fruits)]);
print_r($fruits); // apple is gone

// Correct: check the result with !== false
$fruits = ["apple", "banana", "cherry"];
$key = array_search("grape", $fruits);
if ($key !== false) {
    unset($fruits[$key]);
}
print_r($fruits);

Sempre guarde o resultado do array_search e compare com !== false antes de usá-lo como chave. Um simples if ($key) também não basta: uma correspondência no índice 0 também é falsa.