PHPで配列の要素を削除：unset、array_splice

PHPの配列からキーで要素を削除するには、unset($array[$key])を使います。要素はなくなり、ほかのキーはそのまま残り、存在しないキーをunsetしてもエラーにはなりません。

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

2つ目の結果を見てください。キーは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)は、位置$offsetから$length個の要素を削除してキーを振り直し、削除したものを返します。負のオフセットは末尾から数えます。同じ呼び出しで置き換えの要素を挿入することもできます。

<?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でキーを探して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);

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は1回の呼び出しで複数の要素を受け付けます。配列で持っているキーのリストを削除するには、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)));

よくあるミス：値がないときのarray_searchとunset

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での一致もfalseと評価されるからです。