func_get_arg

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

func_get_arg — Retourne un élément de la liste des arguments

Description

function func_get_arg(int $position): mixed

Récupère un élément de la liste des arguments d'une fonction utilisateur.

func_get_arg() peut être utilisé conjointement à func_num_args() et func_get_args() pour permettre aux fonctions utilisateurs d'accepter un nombre variable d'arguments.

Liste de paramètres

position: La position de l'argument. Les arguments de la fonction sont comptés en commençant à partir de 0.

Valeurs de retour

Retourne l'argument spécifié, ou false si une erreur survient.

Erreurs / Exceptions

Générera une alerte si elle est appelée hors d'une fonction utilisateur, ou si position est plus grand que le nombre d'arguments passés.

Exemples

Exemple #1 Exemple avec func_get_arg()

<?php
function foo()
{
     $numargs = func_num_args();
     echo "Nombre d'arguments : $numargs\n";
     if ($numargs >= 2) {
         echo "Le second argument est : " . func_get_arg(1) . "\n";
     }
}

foo(1, 2, 3);
?>

L'exemple ci-dessus va afficher :

Nombre d'arguments : 3
Le second argument est : 2

Exemple #2 Exemple func_get_arg() avec des arguments par référence et par valeur

<?php
function byVal($arg) {
    echo 'Tel que passé     : ', var_export(func_get_arg(0)), PHP_EOL;
    $arg = 'baz';
    echo 'Après changement  : ', var_export(func_get_arg(0)), PHP_EOL;
}

function byRef(&$arg) {
    echo 'Tel que passé     : ', var_export(func_get_arg(0)), PHP_EOL;
    $arg = 'baz';
    echo 'Après changement  : ', var_export(func_get_arg(0)), PHP_EOL;
}

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

L'exemple ci-dessus va afficher :

Tel que passé : 'bar'
Après changement : 'baz'
Tel que passé : 'bar'
Après changement : 'baz'

Notes

Note:
À partir de PHP 8.0.0, la famille de fonctions func_*() est conçue pour être essentiellement transparente concernant les arguments nommés, en traitant les arguments comme s'ils étaient tous passés de manière positionnelle, et les arguments manquants sont remplacés par leurs valeurs par défaut. Cette fonction ignore la collection des arguments variadiques nommés inconnus. Les arguments nommés inconnus qui sont collectés ne sont accessibles qu'à travers le paramètre variadique.

Note:
Si les arguments sont passés par référence, toutes leurs modifications seront reflétées dans les valeurs retournées par cette fonction. À partir de PHP 7, les valeurs courantes seront aussi retournées si les arguments sont passés par leur valeur.

Note:
Cette fonction retourne uniquement une copie des arguments passés, et ne compte pas en tant qu'arguments par défaut (non passés).

Voir aussi

La syntaxe ...
func_get_args() - Retourne les arguments d'une fonction sous la forme d'un tableau
func_num_args() - Retourne le nombre d'arguments passés à la fonction