PHP/key

(PHP 4, PHP 5, PHP 7)

تُعيد الدالة key()‎‎ مفتاحًا ما من مصفوفة.

الوصف

mixed key ( array $array )

تُعيد الدالة key()‎‎‎ عنصر الفهرس للموضع الحالي في المصفوفة.

المعاملات

array

المصفوفة المُدخلة.

القيم المعادة

تُعيد الدالة key()‎‎‎‎ ببساطة مفتاح عنصر المصفوفة الذي يشير المؤشر الداخلي إليه حاليًا. ولا تحرك الدالةُ المؤشرَ بأي طريقة. إذا أشار المؤشر الداخلي خارج نهاية قائمة العناصر أو كانت المصفوفة فارغة، تُعيد الدالة key()‎‎‎ القيمة NULL.

سجل التغييرات

الإصدار	الوصف
7.0.0	تُمرر المصفوفة array الآن دائمًا كقيمة. قبل هذا الإصدار، كانت تُمرر بالمرجعية إن أمكن، وبالقيمة بخلاف ذلك.

أمثلة

المثال 1: مثال على الدالة key()‎‎

<?php
$array = array(
   'fruit1' => 'apple',
   'fruit2' => 'orange',
   'fruit3' => 'grape',
   'fruit4' => 'apple',
   'fruit5' => 'apple');
// تُخرج هذه الدورة جميع مفاتيح المصفوفة الترابطية
// كلما كانت قيمتها تساوي "apple"
while ($fruit_name = current($array)) {
   if ($fruit_name == 'apple') {
       echo key($array).'<br />';
   }
   next($array);
}
?>

سوف تكون مُخرجات المثال أعلاه كالتالي:

fruit1<br />
fruit4<br />
fruit5<br />

انظر أيضًا

• الدالة current()‎: إعادة العنصر الحالي في مصفوفة.
• الدالة next()‎‎: تحريك المؤشر الداخلي لمصفوفة إلى الأمام.
• حلقة foreach.

مصادر

• صفحة الدالة key في توثيق PHP الرسمي.