PHP array_splice() Function

Hello folks! welcome back to a new section of our tutorial on PHP. In this tutorial guide, we are going to be studying about the PHP array_splice() Function.

The built-in PHP array_splice() function is used to remove the elements selected by offset and length from the input array, and replaces them with the elements of the replacement array, if it is supplied. It returns an array containing the extracted elements.

Syntax

Following below is the syntax to use this function -

array_splice ( $input, $offset [,$length [,$replacement]] );

READ: PHP array_slice() Function

Parameter Details

Sr.No	Parameter & Description
1	input(Required) It specifies an array
2	offset It specifies where the function will start removing elements. 0 = the first element.
3	length(Optional) It specifies how many elements will be removed, and also length of the returned array.
4	replacement(Optional) It specifies an array with the elements that will be inserted to the original array.

Return Value

This built-in PHP function returns the last value of the array, shortening the array by one element.

Example

Try out the below example -

<?php
   $input = array("red", "black", "pink", "white");
   array_splice($input, 2);
   print_r($input);
   print_r("<br />");

   $input = array("red", "black", "pink", "white");
   array_splice($input, 1, -1);
   print_r($input);
   print_r("<br />");

   $input = array("red", "black", "pink", "white");
   array_splice($input, 1, count($input), "orange");
   print_r($input);
   print_r("<br />");

   $input = array("red", "black", "pink", "white");
   array_splice($input, -1, 1, array("black", "maroon"));
   print_r($input);
   print_r("<br />");

   $input = array("red", "black", "pink", "white");
   array_splice($input, 3, 0, "purple");
   print_r($input);
   print_r("<br />");

?> 

Output

When the above code is executed, it will produce the following result -

Array ( [0]=>red [1] =>black )
Array ( [0]=>red [1] =>white )
Array ( [0]=>red [1] =>orange )
Array ( [0]=>red [1] =>black [2]=>pink [3]=>black [4]=>maroon )
Array ( [0]=>red [1] =>black [2]=>pink [3]=>purple [4]=>white ) 

READ: PHP array_reverse() Function

Alright guys! This is where we are going to be rounding up for this tutorial post. In our next tutorial, we are going to be discussing about the PHP array_sum() Function.

Feel free to ask your questions where necessary and we will attend to them as soon as possible. If this tutorial was helpful to you, you can use the share button to share this tutorial.

Follow us on our various social media platforms to stay updated with our latest tutorials. You can also subscribe to our newsletter in order to get our tutorials delivered directly to your emails.

Thanks for reading and bye for now.