array_shift()‎

(PHP 4, PHP 5, PHP 7)

تُزيل الدالة array_shift()‎ عنصرًا من بداية المصفوفة وتُعيد قيمته.

الوصف

mixed array_shift ( array &$array )

تُزيل array_shift()‎ العنصر الأول من المصفوفة array وتعيد قيمته، مع تقصير المصفوفة array بمقدار عنصر واحد وإزاحة جميع العناصر نحو بداية المصفوفة. تُعدَّل جميع المفاتيح العددية للمصفوفة لبدء العد من الصفر بينما لا تتغير المفاتيح الحرفية.

ملاحظة: تعيد هذه الدالة ضبط مؤشر المصفوفة باستخدام الدالة ()‎reset بعد استعمالها.

المعاملات

array

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

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

تعيد قيمة العنصر المحذوف، أو القيمة NULL إذا كانت المصفوفة array فارغةً (أو ليست مصفوفة).

أمثلة

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

<?php
$stack = array("orange", "banana", "apple", "raspberry");
$fruit = array_shift($stack);
print_r($stack);
?>

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

Array
(
    [0] => banana
    [1] => apple
    [2] => raspberry
)

وستُسنَد القيمة orange إلى المتغير ‎$fruit.

انظر أيضًا

• الدالة array_unshift()‎: إضافة عنصر واحد أو أكثر لبداية المصفوفة.
• الدالة array_push()‎: إضافة عنصر واحد أو أكثر في نهاية المصفوفة.
• الدالة array_pop()‎: إزالة العنصر الأخير في نهاية المصفوفة وإعادة قيمته.

مصادر

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