عرض مصدر PHP/func get args

<noinclude>{{DISPLAYTITLE:الدالة <code>func_get_args()</code>‎ في PHP}}</noinclude>
(PHP 4, PHP 5, PHP7)

تعيد الدالة <code>func_get_args()</code>‎ بعد استدعائها مصفوفةً عناصرها هي جميع المعاملات التي مُرِّرت للدالة المعرَّفة من طرف المستخدم.

== الوصف ==
<syntaxhighlight lang="php">
array func_get_args ( void )
</syntaxhighlight>تستعمل هذه الدالة غالبًا بالتزامن مع الدالة <code>[[PHP/func get arg|func_get_arg()‎]]</code> والدالة <code>[[PHP/func num args|func_num_args()‎]]</code> وذلك للسماح للدوال المعرفة من طرف المستخدم بقبول عدد متغيّر من المعاملات.

== القيم المعادة ==
عند استدعاء هذه الدالة ضمن دالة معرفة من قبل المستخدم، فإنَّها تعيد مصفوفة عناصرها هي جميع المعاملات التي مُرِّرت إلى تلك الدالة آنذاك.

== سجل التغييرات ==
{| class="wikitable"
!الإصدار
!الوصف
|-
|5.3.0
|يمكن أن تُستعمل هذه الدالة معاملًا لدالة أخرى.
|-
|5.3.0
|أصبح بإمكان هذه الدالة أن تعيد القيمة <code>FALSE</code> إن استُدعيت خارج الدالة المعرفة من طرف المستخدم؛ أي مثلًا إن استُدعيت هذه الدالة من نطاق خارجي وليكن ملف ثم ضُمَّن هذا الملف باستعمال <code>[[PHP/include|include]]</code> أو <code>[[PHP/require|require]]</code> ضمن الدالة المعرَّفة من طرف المستخدم، فإنَّها تعيد <code>FALSE</code>. انظر المثال 2 في الأسفل لتوضيح هذه الفكرة.
|}

== الأخطاء والاستثناءات ==
تولِّد هذه الدالة تحذيرًا إذا استدعيت خارج دالة معرِّفة من طرف المستخدم.

== أمثلة ==
مثال 1: استعمال الدالة <code>func_get_args()‎</code> مع الدالة <code>func_num_args()‎</code> وذلك لمعرفة عدد المعاملات الممرَّرة للدالة وطباعتها:<syntaxhighlight lang="php">
<?php
function foo()
{
    $numargs = func_num_args();
    echo "Number of arguments: $numargs \n";
    if ($numargs >= 2) {
        echo "Second argument is: " . func_get_arg(1) . "\n";
    }
    $arg_list = func_get_args();
    for ($i = 0; $i < $numargs; $i++) {
        echo "Argument $i is: " . $arg_list[$i] . "\n";
    }
}

foo(1, 2, 3);
?>

</syntaxhighlight>يعطي المثال السابق النتيجة التالية:<syntaxhighlight lang="text">
Number of arguments: 3 
Second argument is: 2
Argument 0 is: 1
Argument 1 is: 2
Argument 2 is: 3
</syntaxhighlight>مثال 2: استعمال الدالة <code>func_get_args()‎</code> قبل إصدار PHP 5.3.0 وبعده:

عرَّفنا في هذا المثال الدالة <code>foo()‎</code> ثمَّ ضمنّا الملف fga.inc فيها والذي استدعينا فيه الدالة <code>func_get_args()‎</code>. مرَّرنا بعدئذٍ إلى تلك الدالة معاملين.<syntaxhighlight lang="php">
test.php
<?php
function foo() {
    include './fga.inc';
}

foo('First arg', 'Second arg');
?>

fga.inc
<?php

$args = func_get_args();
var_export($args);

?>

</syntaxhighlight>كان ناتج المثال السابق باستعمال إصدار سابق للإصدار 5.3 هو:<syntaxhighlight lang="text">
array (
  0 => 'First arg',
  1 => 'Second arg',
)
</syntaxhighlight>أما باستعمال إصدار PHP 5.3 وما بعده، فإن ناتج المثال سيكون:<syntaxhighlight lang="text">
Warning: func_get_args():  Called from the global scope - no function
context in /home/torben/Desktop/code/ml/fga.inc on line 3
false
</syntaxhighlight>مثال 3: استعمال <code>func_get_args()‎</code> مع معاملات متغيرة (قيم المتغيرات) باستعمال الدالة <code>byval</code> ومعاملات مرجعية (عناوين المتغيرات) باستعمال الدالة <code>byref</code>:

إنَّ المعامل المُمرَّر إلى الدالة الأولى <code>byVal()‎</code> هو المتغير ‎<code>$arg</code> المُمرَّر بالقيمة، بينما سنمرره في الدالة الثانية بالمرجعية ‎<code>&$arg</code> (راجع قسم [[PHP/references#.D8.A7.D9.84.D8.AA.D9.85.D8.B1.D9.8A.D8.B1 .D8.A8.D8.A7.D9.84.D9.85.D8.B1.D8.AC.D8.B9.D9.8A.D8.A9|التمرير بالمرجعية]] في صفحة [[PHP/references|المراجع]] لمزيدٍ من التفاصيل).<syntaxhighlight lang="php">
<?php
function byVal($arg) {
    echo 'As passed     : ', var_export(func_get_args()), PHP_EOL;
    $arg = 'baz';
    echo 'After change  : ', var_export(func_get_args()), PHP_EOL;
}

function byRef(&$arg) {
    echo 'As passed     : ', var_export(func_get_args()), PHP_EOL;
    $arg = 'baz';
    echo 'After change  : ', var_export(func_get_args()), PHP_EOL;
}

$arg = 'bar';
byVal($arg);
byRef($arg);
?>

</syntaxhighlight>ناتج المثال السابق باستعمال إصدار PHP 7 سيكون:<syntaxhighlight lang="text">
As passed : array (
0 => 'bar',
)
After change : array (
0 => 'baz',
)
As passed : array (
0 => 'bar',
)
After change : array (
0 => 'baz',
)

</syntaxhighlight>أما ناتج المثال السابق باستعمال إصدار PHP 5 سيكون:<syntaxhighlight lang="text">
As passed : array (
0 => 'bar',
)
After change : array (
0 => 'bar',
)
As passed : array (
0 => 'bar',
)
After change : array (
0 => 'baz',
)

</syntaxhighlight>

== ملاحظات ==
* لا يمكن استخدام هذه الدالة معاملًا لدالة أخرى في إصدار قبل 5.3.0 إذ تعتمد على النطاق الحالي (current scope) لتحديد المعاملات. في حال اضطررت إلى ذلك (تمرير قيم هذه الدالة إلى دالة أخرى) فيمكن اسناد القيم إلى متغير ثم تمرير ذلك المتغير إلى الدالة المطلوبة.
* إن مُرِّرت المعاملات بالمرجعية، فإنَّ أي تغيير لتلك المعاملات سينعكس على القيم التي ترجعها هذه الدالة. ستُرجع القيم الحالية في PHP 7 نفسها إذا مرِّرت بالقيمة (معاملات متغيرة).
* تعيد هذه الدالة نسخة عن قيم المعاملات الممرَّرة إلى الدالة المعرَّفة فقط، ولن تأخذ القيم الافتراضية للمعاملات الاختيارية بالحسبان.

== انظر أيضًا ==
* الدالّة <code>[[PHP/func get arg|func_get_arg()‎]]</code>: إعادة وسيط من قائمة الوسائط.
* الدالّة <code>[[PHP/func num args|func_num_args()‎]]</code>: إعادة عدد الوسائط الممرّرة إلى الدّالة.
* الدالّة <nowiki/>[[PHP/ReflectionFunctionAbstract/getNumberOfParameters|<code>ReflectionFunctionAbstract::getNumberOfParameters()</code>‎]].

== مصادر ==
* [http://php.net/manual/en/function.func-get-args.php صفحة الدالة func_get_args في توثيق PHP الرسمي.]
[[تصنيف:PHP]]
[[تصنيف:PHP Function]]
[[تصنيف:PHP Function Handling]]