ChatGPT解决这个技术问题 Extra ChatGPT

Get first key in a (possibly) associative array?

What's the best way to determine the first key in a possibly associative array? My first thought it to just foreach the array and then immediately breaking it, like this:

foreach ($an_array as $key => $val) break;

Thus having $key contain the first key, but this seems inefficient. Does anyone have a better solution?

Why is inefficient foreach?
Compared to all the answers, foreach is still the fastest FIDDLE, PHP 5.3, my localhost test on PHP 5.5 shows that the difference is slightly in favor of foreach.
@Danijel, foreach is semantically wrong.
@AlexS, Either each($arr)['key'] or each($arr)[0] would work.
@Danijel Not any more... key: 0.0107, foreach: 0.0217

M
Matt Kieran

2019 Update

Starting from PHP 7.3, there is a new built in function called array_key_first() which will retrieve the first key from the given array without resetting the internal pointer. Check out the documentation for more info.

You can use reset and key:

reset($array);
$first_key = key($array);

It's essentially the same as your initial code, but with a little less overhead, and it's more obvious what is happening.

Just remember to call reset, or you may get any of the keys in the array. You can also use end instead of reset to get the last key.

If you wanted the key to get the first value, reset actually returns it:

$first_value = reset($array);

There is one special case to watch out for though (so check the length of the array first):

$arr1 = array(false);
$arr2 = array();
var_dump(reset($arr1) === reset($arr2)); // bool(true)

As a side note, reset() also happens to return the first element (value, not key) of any array, which can be handy as well.
There's a comment in the docs to reset() saying Don't use reset()` to get the first value of an associative array. It works great for true arrays but works unexpectedly on Iterator objects. bugs.php.net/bug.php?id=38478` Is that still true? I'm confused
@DmitryPashkevich: Don't worry about that comment. They're not talking about array objects, but custom objects (that are not actual arrays). I guess they got the difference in data structures confused, but basically, reset returns the value of the first "key", which for objects would be $prop in the example given in the "bug" report, but for an array the first key. So don't worry, as long as you use real arrays (created with array(…)), you won't have a problem.
It should be mentioned that end() and reset() have a side effect. However, most code in the world does not rely on the internal pointer being anywhere, so this is generally not a problem.
@user3019105 There is only one internal pointer per array, which means that if any code outside your function changes it (by calling next, reset, end or looping through the array), you won't get the expected value when you call key. So yes, always call reset before using key to be sure you get what you want.
t
troelskn

array_keys returns an array of keys. Take the first entry. Alternatively, you could call reset on the array, and subsequently key. The latter approach is probably slightly faster (Thoug I didn't test it), but it has the side effect of resetting the internal pointer.


Just a (late) note for future readers of this: The latter approach is not just "slightly" faster. There's a big difference between iterating an entire array, storing every key in another newly created array, and requesting the first key of an array as a string.
Why is inefficient foreach as the op has in the question compare to all these answers?
@EmilioGort Good question. I don't think there's any difference in the performance of foreach + break and reset + key actually. But the former looks rather weird, so for stylistic issues, I would prefer the latter.
@EmilioGort: Afaik, foreach() copies the array internally. So we can assume it to be slower. (Would be nice if someone could confirm that)
@donquixote I don't know for sure, but assuming it's a regular array (and not an object implementing some kind or Iterator interface), I'm fairly sure foreach doesn't create an internal copy for it, but rather just iterates a pointer, similar to using the more low-level next, current etc.
W
Webmut

Interestingly enough, the foreach loop is actually the most efficient way of doing this.

Since the OP specifically asked about efficiency, it should be pointed out that all the current answers are in fact much less efficient than a foreach.

I did a benchmark on this with php 5.4, and the reset/key pointer method (accepted answer) seems to be about 7 times slower than a foreach. Other approaches manipulating the entire array (array_keys, array_flip) are obviously even slower than that and become much worse when working with a large array.

Foreach is not inefficient at all, feel free to use it!

Edit 2015-03-03:

Benchmark scripts have been requested, I don't have the original ones but made some new tests instead. This time I found the foreach only about twice as fast as reset/key. I used a 100-key array and ran each method a million times to get some noticeable difference, here's code of the simple benchmark:

$array = [];
for($i=0; $i < 100; $i++)
    $array["key$i"] = $i;

for($i=0, $start = microtime(true); $i < 1000000; $i++) {
    foreach ($array as $firstKey => $firstValue) {
        break;
    }
}
echo "foreach to get first key and value: " . (microtime(true) - $start) . " seconds <br />";

for($i=0, $start = microtime(true); $i < 1000000; $i++) {
    $firstValue = reset($array);
    $firstKey = key($array);
}
echo "reset+key to get first key and value: " . (microtime(true) - $start) . " seconds <br />";

for($i=0, $start = microtime(true); $i < 1000000; $i++) {
    reset($array);
    $firstKey = key($array);
}
echo "reset+key to get first key: " . (microtime(true) - $start) . " seconds <br />";


for($i=0, $start = microtime(true); $i < 1000000; $i++) {
    $firstKey = array_keys($array)[0];
}
echo "array_keys to get first key: " . (microtime(true) - $start) . " seconds <br />";

On my php 5.5 this outputs:

foreach to get first key and value: 0.15501809120178 seconds 
reset+key to get first key and value: 0.29375791549683 seconds 
reset+key to get first key: 0.26421809196472 seconds 
array_keys to get first key: 10.059751987457 seconds

reset+key http://3v4l.org/b4DrN/perf#tabs
foreach http://3v4l.org/gRoGD/perf#tabs


Do you have the benchmarks somewhere. Like how you tested etc. Anyway, thank you for running them!
I would like to point at the fact, that there is same array used through the whole test. I think that this fact significantly influences the foreach approach. As @donquixote mentioned in comment to some response above - foreach internally copies the array. I can imagine that this copy is reused while running the benchmark since avoidance of array copying enhances performance only within this test.
@Jarda As of php7, foreach never copies the array unless you directly modify it inside the foreach loop. On php5 the array structure could be copied in some cases (when its refcount > 1) and you are actually right it could be a significant influence there. Fortunately it's nothing to worry about on php7, where this issue was resolved. Here's a great read both on how foreach works under the hood now and how it worked in the past.
as of php7.2 using the above benchmark, foreach is still fastest
j
jimyi

key($an_array) will give you the first key

edit per Blixt: you should call reset($array); before key($an_array) to reset the pointer to the beginning of the array.


Remember that the pointer of the array may not be at the first element, see my answer.
I think this answer will help my case without reset because I'm first making sure the array has only one element. Thanks
P
Pang

You could try

array_keys($data)[0]

i
ivanaugustobd

For 2018+

Starting with PHP 7.3, there is an array_key_first() function that achieve exactly this:

$array = ['foo' => 'lorem', 'bar' => 'ipsum'];
$firstKey = array_key_first($array); // 'foo'

Documentation is available here. 😉


S
Sergiy Sokolenko
list($firstKey) = array_keys($yourArray);

This is probably not the most efficient.
@Yada, yes, but this might be noticeable in rare cases; in most cases readability and maintainability are of much greater importance; and I also prefer solution which does not mutate original objects/arrays: e.g. reset($ar); $key = key($ar); -- is not always good idea, I'd rather chose MartyIX 's solution which is more concise than mine, e.g.: array_keys($ar)[0];
M
MartyIX

If efficiency is not that important for you, you can use array_keys($yourArray)[0] in PHP 5.4 (and higher).

Examples:

# 1
$arr = ["my" => "test", "is" => "best"];    
echo array_keys($arr)[0] . "\r\n"; // prints "my"


# 2
$arr = ["test", "best"];
echo array_keys($arr)[0] . "\r\n"; // prints "0"

# 3
$arr = [1 => "test", 2 => "best"];
echo array_keys($arr)[0] . "\r\n"; // prints "1"

The advantage over solution:

list($firstKey) = array_keys($yourArray);

is that you can pass array_keys($arr)[0] as a function parameter (i.e. doSomething(array_keys($arr)[0], $otherParameter)).

HTH


Does array_keys($arr)[0] syntax is valid?
It is in PHP 5.4. It's called array dereferencing. See for example: schlueters.de/blog/archives/…
@trante, It's valid in every language under the sun except PHP < 5.4.
P
Pupil

Please find the following:

$yourArray = array('first_key'=> 'First', 2, 3, 4, 5);
$keys   =   array_keys($yourArray);
echo "Key = ".$keys[0];

Working Example:


H
Hamidreza
$myArray = array(
    2 => '3th element',
    4 => 'first element',
    1 => 'second element',
    3 => '4th element'
);
echo min(array_keys($myArray)); // return 1

@jurgemaister max() dose not return first key of an assoc array. max return maximum value of a list or an array items
Not the OP request, but very useful in some situations.
A
Arsen Khachaturyan

This could also be a solution:

$yourArray = array('first_key'=> 'First', 2, 3, 4, 5);
$first_key = current(array_flip($yourArray));
echo $first_key;

I have tested it and it works.

Working Code.


array_flip(): Can only flip STRING and INTEGER values!
P
PrinsEdje80

To enhance on the solution of Webmut, I've added the following solution:

$firstKey = array_keys(array_slice($array, 0, 1, TRUE))[0];

The output for me on PHP 7.1 is:

foreach to get first key and value: 0.048566102981567 seconds 
reset+key to get first key and value: 0.11727809906006 seconds 
reset+key to get first key: 0.11707186698914 seconds 
array_keys to get first key: 0.53917098045349 seconds 
array_slice to get first key: 0.2494580745697 seconds 

If I do this for an array of size 10000, then the results become

foreach to get first key and value: 0.048488140106201 seconds 
reset+key to get first key and value: 0.12659382820129 seconds 
reset+key to get first key: 0.12248802185059 seconds 
array_slice to get first key: 0.25442600250244 seconds 

The array_keys method times out at 30 seconds (with only 1000 elements, the timing for the rest was about the same, but the array_keys method had about 7.5 seconds).


v
voodoo417
 $arr = array('key1'=>'value1','key2'=>'value2','key3'=>'key3');
 list($first_key) = each($arr);
 print $first_key;
 // key1

S
Salvi Pascual

This is the easier way I had ever found. Fast and only two lines of code :-D

$keys = array_keys($array);
echo $array[$keys[0]];

Y
Yuriy Petrovskiy

The best way that worked for me was

array_shift(array_keys($array))

array_keys gets array of keys from initial array and then array_shift cuts from it first element value. You will need PHP 5.4+ for this.


B
Benjamin Beganović

php73:

$array = ['a' => '..', 'b' => '..'];

array_key_first($array); // 'a'
array_key_last($array); // 'b';

http://php.net/manual/en/function.array-key-first.php


Including an explanation really helps to improve the quality of your post. Remember that you are answering the question for readers in the future, and those people might not know the reasons for your code suggestion
A
AndreyP

Since PHP 7.3.0 function array_key_first() can be used.

There are several ways to provide this functionality for versions prior to PHP 7.3.0. It is possible to use array_keys(), but that may be rather inefficient. It is also possible to use reset() and key(), but that may change the internal array pointer. An efficient solution, which does not change the internal array pointer, written as polyfill:

<?php
if (!function_exists('array_key_first')) {
    function array_key_first(array $arr) {
        foreach($arr as $key => $unused) {
            return $key;
        }

        return null;
    }
}
?>

S
Shahroq

Re the @Blixt answer, prior to 7.3.0, this polyfill can be used:

if (!function_exists('array_key_first')) {
  function array_key_first(array $array) {
    return key(array_slice($array, 0, 1, true));
  }
}

P
Pijush Gupta

This will work on all PHP versions

$firstKey = '' ;

//$contact7formlist - associative array. 

if(function_exists('array_key_first')){
    
    $firstKey = array_key_first($contact7formlist);
    
}else{
    
    foreach ($contact7formlist as $key => $contact7form ){
        $firstKey = $key;
        break;
    }
}

K
Kohjah Breese

A one-liner:

$array = array('key1'=>'value1','key2'=>'value2','key3'=>'key3');
echo key( array_slice( $array, 0, 1, true ) );

# echos 'key1'

C
Chris Stadler

Today I had to search for the first key of my array returned by a POST request. (And note the number for a form id etc)

Well, I've found this: Return first key of associative array in PHP

http://php.net/key

I've done this, and it work.

    $data = $request->request->all();
    dump($data);
    while ($test = current($data)) {
        dump($test);
        echo key($data).'<br />';die();
        break;
    }

Maybe it will eco 15min of an other guy. CYA.


F
Fabián Fernández

I think the best and fastest way to do it is:

$first_key=key(array_slice($array, 0, 1, TRUE))

T
Toto

array_chunk split an array into chunks, you can use:

$arr = ['uno'=>'one','due'=>'two','tre'=>'three'];
$firstElement = array_chunk($arr,1,true)[0];
var_dump($firstElement);

P
Priyank

You can play with your array

$daysArray = array('Monday', 'Tuesday', 'Sunday');
$day = current($transport); // $day = 'Monday';
$day = next($transport);    // $day = 'Tuesday';
$day = current($transport); // $day = 'Tuesday';
$day = prev($transport);    // $day = 'Monday';
$day = end($transport);     // $day = 'Sunday';
$day = current($transport); // $day = 'Sunday';

To get the first element of array you can use current and for last element you can use end

Edit

Just for the sake for not getting any more down votes for the answer you can convert you key to value using array_keys and use as shown above.


These are values, not keys.
J
Javed Khan

use :

$array = ['po','co','so'];

echo reset($array); 

Result : po