This is one stop global knowledge base where you can learn about all the products, solutions and support features.
(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)
array_search — Searches the array for a given value and returns the first corresponding key if successful
array_search(mixed $needle, array $haystack, bool $strict = false): int|string|false
Searches for
needle
in
haystack
.
needle
The searched value.
Note :
If
needle
is a string, the comparison is done in a case-sensitive manner.
haystack
The array.
strict
If the third parameter
strict
is set to
true
then the
array_search()
function will search for
identical
elements in the
haystack
. This means it will also perform a strict type comparison of the
needle
in the
haystack
, and objects must be the same instance.
Returns the key for
needle
if it is found in the array,
false
otherwise.
If
needle
is found in
haystack
more than once, the first matching key is returned. To return the keys for all matching values, use
array_keys()
with the optional
search_value
parameter instead.
This function may return Boolean
false
, but may also return a non-Boolean value which evaluates to
false
. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.
Example #1 array_search() example
<?php
$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');
$key = array_search('green', $array); // $key = 2;
$key = array_search('red', $array); // $key = 1;
?>
(PHP 4, PHP 5, PHP 7, PHP 8)
array_shift — Shift an element off the beginning of array
array_shift(array &$array): mixed
array_shift()
shifts the first value of the
array
off and returns it, shortening the
array
by one element and moving everything down. All numerical array keys will be modified to start counting from zero while literal keys won't be affected.
Note : This function will reset() the array pointer of the input array after use.
array
The input array.
Returns the shifted value, or
null
if
array
is empty or is not an array.
Example #1 array_shift() example
<?php
$stack = array("orange", "banana", "apple", "raspberry");
$fruit = array_shift($stack);
print_r($stack);
?>
The above example will output:
Array ( [0] => banana [1] => apple [2] => raspberry )
and
orange
will be assigned to
$fruit
.
(PHP 4, PHP 5, PHP 7, PHP 8)
array_slice — Extract a slice of the array
array_slice( array $array, int $offset, ?int $length = null, bool $preserve_keys = false ): array
array_slice()
returns the sequence of elements from the array
array
as specified by the
offset
and
length
parameters.
array
The input array.
offset
If
offset
is non-negative, the sequence will start at that offset in the
array
.
If
offset
is negative, the sequence will start that far from the end of the
array
.
Note :
The
offset
parameter denotes the position in the array, not the key.
length
If
length
is given and is positive, then the sequence will have up to that many elements in it.
If the array is shorter than the
length
, then only the available array elements will be present.
If
length
is given and is negative then the sequence will stop that many elements from the end of the array.
If it is omitted, then the sequence will have everything from
offset
up until the end of the
array
.
preserve_keys
Note :
array_slice() will reorder and reset the integer array indices by default. This behaviour can be changed by setting
preserve_keys
totrue
. String keys are always preserved, regardless of this parameter.
Returns the slice. If the offset is larger than the size of the array, an empty array is returned.
Example #1 array_slice() examples
<?php
$input = array("a", "b", "c", "d", "e");
$output = array_slice($input, 2); // returns "c", "d", and "e"
$output = array_slice($input, -2, 1); // returns "d"
$output = array_slice($input, 0, 3); // returns "a", "b", and "c"
// note the differences in the array keys
print_r(array_slice($input, 2, -1));
print_r(array_slice($input, 2, -1, true));
?>
The above example will output:
Array ( [0] => c [1] => d ) Array ( [2] => c [3] => d )
Example #2 array_slice() and one-based array
<?php
$input = array(1 => "a", "b", "c", "d", "e");
print_r(array_slice($input, 1, 2));
?>
The above example will output:
Array ( [0] => b [1] => c )
Example #3 array_slice() and array with mixed keys
<?php
$ar = array('a'=>'apple', 'b'=>'banana', '42'=>'pear', 'd'=>'orange');
print_r(array_slice($ar, 0, 3));
print_r(array_slice($ar, 0, 3, true));
?>
The above example will output:
Array ( [a] => apple [b] => banana [0] => pear ) Array ( [a] => apple [b] => banana [42] => pear )
(PHP 4, PHP 5, PHP 7, PHP 8)
array_splice — Remove a portion of the array and replace it with something else
array_splice( array &$array, int $offset, ?int $length = null, mixed $replacement = [] ): array
Removes the elements designated by
offset
and
length
from the
array
array, and replaces them with the elements of the
replacement
array, if supplied.
Note :
Numerical keys in
array
are not preserved.
Note : If
replacement
is not an array, it will be typecast to one (i.e.(array) $replacement
). This may result in unexpected behavior when using an object ornull
replacement
.
array
The input array.
offset
If
offset
is positive then the start of the removed portion is at that offset from the beginning of the
array
array.
If
offset
is negative then the start of the removed portion is at that offset from the end of the
array
array.
length
If
length
is omitted, removes everything from
offset
to the end of the array.
If
length
is specified and is positive, then that many elements will be removed.
If
length
is specified and is negative, then the end of the removed portion will be that many elements from the end of the array.
If
length
is specified and is zero, no elements will be removed.
To remove everything from
offset
to the end of the array when
replacement
is also specified, use
count($input)
for
length
.
replacement
If
replacement
array is specified, then the removed elements are replaced with elements from this array.
If
offset
and
length
are such that nothing is removed, then the elements from the
replacement
array are inserted in the place specified by the
offset
.
Note :
Keys in the
replacement
array are not preserved.
If
replacement
is just one element it is not necessary to put
array()
or square brackets around it, unless the element is an array itself, an object or
null
.
Returns an array consisting of the extracted elements.
Version | Description |
---|---|
8.0.0 |
length
is nullable now.
|
Example #1 array_splice() examples
<?php
$input = array("red", "green", "blue", "yellow");
array_splice($input, 2);
var_dump($input);
$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, -1);
var_dump($input);
$input = array("red", "green", "blue", "yellow");
array_splice($input, 1, count($input), "orange");
var_dump($input);
$input = array("red", "green", "blue", "yellow");
array_splice($input, -1, 1, array("black", "maroon"));
var_dump($input);
?>
The above example will output:
array(2) { [0]=> string(3) "red" [1]=> string(5) "green" } array(2) { [0]=> string(3) "red" [1]=> string(6) "yellow" } array(2) { [0]=> string(3) "red" [1]=> string(6) "orange" } array(5) { [0]=> string(3) "red" [1]=> string(5) "green" [2]=> string(4) "blue" [3]=> string(5) "black" [4]=> string(6) "maroon" }
Example #2 Equivalent statements to various array_splice() examples
The following statements are equivalent:
<?php
// append two elements to $input
array_push($input, $x, $y);
array_splice($input, count($input), 0, array($x, $y));
// remove the last element of $input
array_pop($input);
array_splice($input, -1);
// remove the first element of $input
array_shift($input);
array_splice($input, 0, 1);
// insert an element at the start of $input
array_unshift($input, $x, $y);
array_splice($input, 0, 0, array($x, $y));
// replace the value in $input at index $x
$input[$x] = $y; // for arrays where key equals offset
array_splice($input, $x, 1, $y);
?>
(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)
array_sum — Calculate the sum of values in an array
array_sum(array $array): int|float
array_sum() returns the sum of values in an array.
array
The input array.
Returns the sum of values as an integer or float;
0
if the
array
is empty.
Example #1 array_sum() examples
<?php
$a = array(2, 4, 6, 8);
echo "sum(a) = " . array_sum($a) . "\n";
$b = array("a" => 1.2, "b" => 2.3, "c" => 3.4);
echo "sum(b) = " . array_sum($b) . "\n";
?>
The above example will output:
sum(a) = 20 sum(b) = 6.9
(PHP 5, PHP 7, PHP 8)
array_udiff — Computes the difference of arrays by using a callback function for data comparison
array_udiff(array $array, array ...$arrays, callable $value_compare_func): array
Computes the difference of arrays by using a callback function for data comparison. This is unlike array_diff() which uses an internal function for comparing the data.
array
The first array.
arrays
Arrays to compare against.
value_compare_func
The callback comparison function.
The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second.
callback(mixed $a, mixed $b): int
Returns an array containing all the values of
array
that are not present in any of the other arguments.
Example #1 array_udiff() example using stdClass Objects
<?php
// Arrays to compare
$array1 = array(new stdclass, new stdclass,
new stdclass, new stdclass,
);
$array2 = array(
new stdclass, new stdclass,
);
// Set some properties for each object
$array1[0]->width = 11; $array1[0]->height = 3;
$array1[1]->width = 7; $array1[1]->height = 1;
$array1[2]->width = 2; $array1[2]->height = 9;
$array1[3]->width = 5; $array1[3]->height = 7;
$array2[0]->width = 7; $array2[0]->height = 5;
$array2[1]->width = 9; $array2[1]->height = 2;
function compare_by_area($a, $b) {
$areaA = $a->width * $a->height;
$areaB = $b->width * $b->height;
if ($areaA < $areaB) {
return -1;
} elseif ($areaA > $areaB) {
return 1;
} else {
return 0;
}
}
print_r(array_udiff($array1, $array2, 'compare_by_area'));
?>
The above example will output:
Array ( [0] => stdClass Object ( [width] => 11 [height] => 3 ) [1] => stdClass Object ( [width] => 7 [height] => 1 ) )
Example #2 array_udiff() example using DateTime Objects
<?php
class MyCalendar {
public $free = array();
public $booked = array();
public function __construct($week = 'now') {
$start = new DateTime($week);
$start->modify('Monday this week midnight');
$end = clone $start;
$end->modify('Friday this week midnight');
$interval = new DateInterval('P1D');
foreach (new DatePeriod($start, $interval, $end) as $freeTime) {
$this->free[] = $freeTime;
}
}
public function bookAppointment(DateTime $date, $note) {
$this->booked[] = array('date' => $date->modify('midnight'), 'note' => $note);
}
public function checkAvailability() {
return array_udiff($this->free, $this->booked, array($this, 'customCompare'));
}
public function customCompare($free, $booked) {
if (is_array($free)) $a = $free['date'];
else $a = $free;
if (is_array($booked)) $b = $booked['date'];
else $b = $booked;
if ($a == $b) {
return 0;
} elseif ($a > $b) {
return 1;
} else {
return -1;
}
}
}
// Create a calendar for weekly appointments
$myCalendar = new MyCalendar;
// Book some appointments for this week
$myCalendar->bookAppointment(new DateTime('Monday this week'), "Cleaning GoogleGuy's apartment.");
$myCalendar->bookAppointment(new DateTime('Wednesday this week'), "Going on a snowboarding trip.");
$myCalendar->bookAppointment(new DateTime('Friday this week'), "Fixing buggy code.");
// Check availability of days by comparing $booked dates against $free dates
echo "I'm available on the following days this week...\n\n";
foreach ($myCalendar->checkAvailability() as $free) {
echo $free->format('l'), "\n";
}
echo "\n\n";
echo "I'm busy on the following days this week...\n\n";
foreach ($myCalendar->booked as $booked) {
echo $booked['date']->format('l'), ": ", $booked['note'], "\n";
}
?>
The above example will output:
I'm available on the following days this week... Tuesday Thursday I'm busy on the following days this week... Monday: Cleaning GoogleGuy's apartment. Wednesday: Going on a snowboarding trip. Friday: Fixing buggy code.
Note : Please note that this function only checks one dimension of a n-dimensional array. Of course you can check deeper dimensions by using
array_udiff($array1[0], $array2[0], "data_compare_func");
.