How can I remove a single array member using array_splice in php?

EmmyS picture EmmyS · Sep 27, 2010 · Viewed 14.2k times · Source

I think I may not understand correctly how array_splice is supposed to work. My understanding is that the first param is your initial array, the second param is the element to start at, and the third param is the length, or number of elements to remove/replace.

So, I have this array (print_r output):

Array ( 
[0] => Array ( [TypeFlag] => S [qty] => 1 [denom] => 25 [certMessage] => [totalPrice] => 25 ) 
[1] => Array ( [TypeFlag] => C [qty] => 2 [denom] => 25 [certMessage] => [totalPrice] => 50 ) 
[2] => Array ( [TypeFlag] => V [qty] => 2 [denom] => 25 [certMessage] => test [totalPrice] => 50 ) )

I want to completely remove the second element (the array with index of 1; TypeFlag = C, etc.) I do not want to replace it with anything; just to return the array with the remaining two elements. I've tried this (where cart is the array name):

$cart = array_splice($cart, 1,1);

But what I end up with is this when doing a print_r:

Array ( [0] => Array ( [TypeFlag] => C [qty] => 2 [denom] => 25 [certMessage] => [totalPrice] => 50 ) ) 

So it appears to be removing 0 and 2, and leaving 1 as the remainder. What am I doing wrong?

Answer

codaddict picture codaddict · Sep 27, 2010

array_splice returns an array consisting of the extracted elements.

You are doing:

$cart = array_splice($cart, 1,1);

So you are extracting 2nd element (index 1) and are assigning the result back to $cart, overwriting your original array.

To completely remove the 2nd element do not assign the return value of array_splice back to $cart. So just do:

array_splice($cart, 1,1);

This works because the array is passed by reference to the function.

Also if you want to remove a single element from the array its more efficient and cleaner to use unset as:

unset($cart[1]);