key

(PHP 4, PHP 5, PHP 7, PHP 8)

key — Bir diziden gösterici konumundaki anahtarı döndürür

Açıklama

key(array|object $dizi): int|string|null

key() işlevi belirtilen diziden göstericinin işaret ettiği elemanın anahtarını döndürür.

Bağımsız Değişkenler

dizi: Anahtarın alınacağı dizi.

Dönen Değerler

Dahili göstericinin üzerinde bulunduğu elemanın anahtarını döndürür. Eğer gösterici son elemandan sonrasını gösteriyorsa null döner.

Sürüm Bilgisi

Sürüm:	Açıklama
8.1.0	Bu işlevin nesnelerden çağrılması artık önerilmiyor. Ya nesne önce get_mangled_object_vars() kullanılarak bir diziye dönüştürülmeli ya da bunun yerine Iterator arayüzünü gerçekleyen bir sınıf tarafından sağlanan ArrayIterator gibi yöntemler kullanılmalıdır.
7.4.0	SPL sınıflarının örnekleri, artık bu işlevle aynı ada sahip Iterator yöntemini çağırmak yerine hiçbir özelliği olmayan boş nesneler gibi ele alınıyor.

Örnekler

Örnek 1 - key() örneği

<?php
$dizi = array(
    'meyve1' => 'elma',
    'meyve2' => 'muz',
    'meyve3' => 'armut',
    'meyve4' => 'elma',
    'meyve5' => 'elma');

// Değeri "elma" olan tüm anahtarları gösterir
while ($meyve_adı = current($dizi)) {
    if ($meyve_adı == 'elma') {
        echo key($dizi). "\n";
    }
    next($dizi);
}
?>

Yukarıdaki örneğin çıktısı:

meyve1
meyve4
meyve5

Ayrıca Bakınız

current() - Bir diziden gösterici konumundaki elemanı döndürür
next() - Dahili dizi göstericisini bir ilerletir
array_key_first() - Dizinin ilk anahtarı ile döner
foreach

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 notes

down

414

lhardie ¶

10 years ago

Note that using key($array) in a foreach loop may have unexpected results.  

When requiring the key inside a foreach loop, you should use:
foreach($array as $key => $value)

I was incorrectly using:
<?php
foreach($array as $value)
{
  $mykey = key($array);
}
?>

and experiencing errors (the pointer of the array is already moved to the next item, so instead of getting the key for $value, you will get the key to the next value in the array)

CORRECT:
<?php
foreach($array as $key => $value)
{
  $mykey = $key;
}

A noob error, but felt it might help someone else out there.

down

vinob44 at gmail dot com ¶

11 years ago

Suppose if the array values are in numbers and numbers contains `0` then the loop will be terminated. To overcome this you can user like this

<?php
$array = array(
    '0' => '5',
    '1' => '2',
    '2' => '0',
    '3' => '3',
    '4' => '1');

// wrong approach

while ($fruit_name = current($array)) {

        echo key($array).'<br />';
       next($array);
}

// the way will be break loop when arra('2'=>0) because its value is '0', while(0) will terminate the loop

// correct approach
while ( ($fruit_name = current($array)) !== FALSE ) {

        echo key($array).'<br />';
       next($array);
}
//this will work properly
?>

down

FatBat ¶

13 years ago

Needed to get the index of the max/highest value in an assoc array.
max() only returned the value, no index, so I did this instead.

<?php
reset($x);   // optional.
arsort($x);
$key_of_max = key($x);   // returns the index.
?>

＋add a note