Удалить элемент из массива PHP: unset, array_splice

Чтобы удалить элемент из массива PHP по ключу, используйте unset($array[$key]). Элемент исчезает, остальные ключи остаются ровно такими, как были, а удаление несуществующего ключа не ошибка.

<?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);

Посмотрите на второй результат: теперь ключи 0, 2, 3. unset никогда не перенумеровывает.

Перенумерация массива после unset

Список с пропуском в ключах потом создаёт проблемы: цикл for ($i = 0; ...) натыкается на отсутствующий индекс, а json_encode записывает JSON-объект вместо массива. array_values() возвращает чистые ключи.

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

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

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

Удаление по позиции через array_splice

array_splice($array, $offset, $length) удаляет $length элементов начиная с позиции $offset, перенумеровывает ключи и возвращает удалённое. Отрицательное смещение отсчитывается с конца. В том же вызове можно вставить элементы на замену.

<?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);

array_splice работает с позициями, а не с ключами: в ассоциативном массиве она удаляет по месту в порядке элементов и сохраняет строковые ключи. На странице array_slice она сравнивается с array_slice, которая копирует часть, не меняя оригинал.

Удаление элемента по значению

array_diff($array, [$value]) возвращает массив без всех элементов, равных $value, сохраняя ключи остальных. Чтобы удалить только первое совпадение, найдите его ключ через array_search и удалите.

<?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);

array_diff сравнивает значения как строки, поэтому array_diff([1, "1", 2], [1]) удаляет и целое число, и строку. Когда условие сложнее, чем "равно этому значению", используйте array_filter с колбэком.

Удаление первого или последнего элемента

array_shift() удаляет первый элемент, а array_pop() последний. Обе возвращают удалённый элемент, что удобно для очередей и стеков.

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

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

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

array_shift перенумеровывает числовые ключи с 0. array_pop это не нужно, потому что пропуск оказывается в конце.

Удаление нескольких ключей сразу

unset принимает несколько элементов за один вызов. Чтобы удалить список ключей, который лежит в массиве, переверните его через array_flip(), чтобы имена стали ключами, и передайте в 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)));

Частая ошибка: unset с array_search, когда значения нет

array_search возвращает false, когда ничего не нашла, а false в качестве ключа массива становится 0. Поэтому эта строка удаляет первый элемент всякий раз, когда значения в массиве нет:

<?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);

Всегда сохраняйте результат array_search и сравнивайте его через !== false, прежде чем использовать как ключ. Простого if ($key) тоже недостаточно: совпадение с индексом 0 тоже ложно.