PHP/array key exists

(PHP 4 >= 4.07, PHP 5, PHP 7)

تتحقق الدالة array_key_exists()‎ من وجود المفتاح أو الفهرس داخل المصفوفة.

الوصف

bool array_key_exists ( mixed $key , array $array )

تعيد الدالة القيمة true إذا كان المفتاح key موجودًا بالمصفوفة. يمكن أن يأخذ المتغير key أي قيمة مسموح بها كفهرس للمصفوفة.

المعاملات

key

المفتاح الذي ستتحقق الدالة من وجوده بالمصفوفة.

array

مصفوفة تحتوي على المفاتيح التي ستبحث الدالة فيها.

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

تعيد القيمة true في حالة النجاح والقيمة false في حالة الفشل.

لاحظ أن الدالة ستبحث عن المفاتيح داخل البعد الأول فقط. لن تعثر الدالة على المفاتيح المتداخلة في المصفوفات متعددة الأبعاد.

أمثلة

المثال 1: مثال بسيط عن الدالة array_key_exists()‎

<?php
$search_array = array('first' => 1, 'second' => 4);
if (array_key_exists('first', $search_array)) {
    echo "The 'first' element is in the array";
}
?>

المثال 2: مقارنة الدالة array_key_exists()‎ بالدالة isset()‎

<?php
$search_array = array('first' => null, 'second' => 4);

// false
isset($search_array['first']);

// true
array_key_exists('first', $search_array);
?>

ملاحظات

تعيد الدالة القيمة true إذا كان المفتاح هو خاصيةٌ (property) في الكائن (object) المُمَرر إلى الدالة كمصفوفة وذلك لدعم الإصدارات السابقة. لا يجب الاعتماد على هذا السلوك ويجب التحقق من أن المعامل array هو من النوع array.

استخدم الدالة property_exists()‎ للتحقق من وجود صفة داخل أحد الكائنات.

انظر أيضًا

• الدالة isset()‎: تحدد ما إذا كان المتغير موجودٌ وأن قيمته لا تساوي NULL.
• الدالة array_keys()‎: تعيد كل أو قسم من مفاتيح المصفوفة.
• الدالة in_array()‎: تتحقق من وجود إحدى القيم داخل المصفوفة.
• الدالة property_exists()‎: تتحقق من وجود إحدى الخاصيات داخل الكائن.

مصادر

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