Edit Report a Bug

call_user_func_array

(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

call_user_func_array — Appelle une fonction de rappel avec les paramètres rassemblés en tableau

Description

call_user_func_array(callable $callback, array $args): mixed

Appelle la fonction de rappel callback fournie avec les paramètres args, rassemblés dans un tableau.

Liste de paramètres

callback

La fonction de rappel à appeler.

args

Les paramètres à passer à la fonction de rappel, sous la forme d'un tableau.

Si les clés de args sont toutes numériques, les clés sont ignorées et chaque élément sera transmis à callback en tant qu'argument positionnel, dans l'ordre.

Si certaines clés de args sont des chaînes de caractères, ces éléments seront transmis à callback en tant qu'arguments nommés, avec le nom donné par la clé.

Il est interdit d'avoir une clé numérique dans args qui apparaît après une clé de chaîne de caractères, ou d'avoir une clé de chaîne de caractères qui ne correspond pas au nom d'un quelconque paramètre de callback

Valeurs de retour

Retourne la valeur retournée par la fonction de rappel, ou false si une erreur survient.

Historique

Version	Description
8.0.0	Les clés `args` seront désormais interprétées comme des noms de paramètres, au lieu d'être ignorées silencieusement.

Exemples

Exemple #1 Exemple avec call_user_func_array()

<?php
function foobar($arg, $arg2) {
    echo __FUNCTION__, " got $arg and $arg2\n";
}
class foo {
    function bar($arg, $arg2) {
        echo __METHOD__, " got $arg and $arg2\n";
    }
}


// Appel de la fonction foobar() avec 2 arguments
call_user_func_array("foobar", array("one", "two"));

// Appel de la méthode $foo->bar() avec 2 arguments
$foo = new foo;
call_user_func_array(array($foo, "bar"), array("three", "four"));
?>

Résultat de l'exemple ci-dessus est similaire à :

foobar got one and two
foo::bar got three and four

Exemple #2 Exemple avec call_user_func_array() en utilisant un espace de nom

<?php

namespace Foobar;

class Foo {
    static public function test($name) {
        print "Bonjour {$name}!\n";
    }
}

call_user_func_array(__NAMESPACE__ .'\Foo::test', array('Hannes'));

call_user_func_array(array(__NAMESPACE__ .'\Foo', 'test'), array('Philip'));

?>

L'exemple ci-dessus va afficher :

Bonjour Hannes!
Bonjour Philip!

Exemple #3 Utilisation d'une fonction lambda

<?php

$func = function($arg1, $arg2) {
    return $arg1 * $arg2;
};

var_dump(call_user_func_array($func, array(2, 4)));

?>

L'exemple ci-dessus va afficher :

int(8)

Exemple #4 En passant une valeur par référence

<?php

function mega(&$a){
    $a = 55;
    echo "function mega \$a=$a\n";
}
$bar = 77;
call_user_func_array('mega',array(&$bar));
echo "global \$bar=$bar\n";

?>

L'exemple ci-dessus va afficher :

function mega $a=55
global $bar=55

Exemple #5 call_user_func_array() en utilisant des arguments nommés

<?php
function foobar($first, $second) {
    echo __FUNCTION__, " got $first and $second\n";
}

// Appeler la fonction foobar() avec des arguments nommés dans un ordre non-positional
call_user_func_array("foobar", array("second" => "two", "first" => "one"));

// Appeler la fonction foobar() avec un argument nommé
call_user_func_array("foobar", array("foo", "second" => "bar"));

// Erreur fatale : Impossible d'utiliser un argument positionnel après un argument nommé
call_user_func_array("foobar", array("first" => "one", "bar"));

?>

Résultat de l'exemple ci-dessus est similaire à :

foobar got one and two
foobar got foo and bar

Fatal error: Uncaught Error: Cannot use positional argument after named argument

Notes

Note:
Notez que les fonctions de rappel enregistrées avec des fonctions comme call_user_func() et call_user_func_array() ne seront pas appelées si une exception n'est pas interceptée alors qu'elle a été lancée dans une précédente fonction de rappel.

Voir aussi

call_user_func() - Appelle une fonction de rappel fournie par le premier argument
ReflectionFunction::invokeArgs() - Invoque les arguments d'une fonction
ReflectionMethod::invokeArgs() - Invoque les arguments

add a note

User Contributed Notes 4 notes

down

admin at torntech dot com ¶

9 years ago


As of PHP 5.6 you can utilize argument unpacking as an alternative to call_user_func_array, and is often 3 to 4 times faster.

<?php
function foo ($a, $b) {
     return $a + $b;
}

$func = 'foo';
$values = array(1, 2);
call_user_func_array($func, $values); 
//returns 3

$func(...$values);
//returns 3
?>

Benchmarks from https://gist.github.com/nikic/6390366
cufa   with 0 args took 0.43453288078308
switch with 0 args took 0.24134302139282
unpack with 0 args took 0.12418699264526
cufa   with 5 args took 0.73408579826355
switch with 5 args took 0.49595499038696
unpack with 5 args took 0.18640494346619
cufa   with 100 args took 5.0327250957489
switch with 100 args took 5.291127204895
unpack with 100 args took 1.2362589836121

down

sebastian dot rapetti at tim dot it ¶

3 years ago


Using PHP 8, call_user_func_array call callback function using named arguments if an array with keys is passed to $args parameter, if the array used has only values, arguments are passed positionally.

<?php

function test(string $param1, string $param2): void
{
    echo $param1.' '.$param2;
}

$args = ['hello', 'world'];
//hello world
call_user_func_array('test', $args);

$args = ['param2' => 'world', 'param1' => 'hello'];
//hello world
call_user_func_array('test', $args);

$args = ['unknown_param' => 'hello', 'param2' => 'world'];
//Fatal error: Uncaught Error: Unknown named parameter $unknown_param
call_user_func_array('test', $args);
?>

down

alangiderick at gmail dot com ¶

1 year ago


It's quite interesting reading the notes in this page especially the one that mentions the difference between argument unpacking being significantly faster than calling `call_user_func_array()` directly by admin at torntech dot com.

This is true for PHP 5 but as from PHP 7.0+, there is no significant difference in the run-time between these two mechanisms of operation. The time taken is almost, if not the same for both operations, so this is already something that tells me that the PHP run-time environment has changed quite a lot (for the PHP 7 rewrite).

I used the example from admin at torntech dot com to check this hypothesis.

down

-2

james at gogo dot co dot nz ¶

19 years ago


Be aware the call_user_func_array always returns by value, as demonstrated here...

<?php    
    function &foo(&$a)
    {
      return $a;
    }
    
    $b = 2;
    $c =& call_user_func_array('foo', array(&$b));
    $c++;
    echo $b . ' ' . $c;    
?>

outputs "2 3", rather than the expected "3 3".

Here is a function you can use in place of call_user_func_array which returns a reference to the result of the function call. 

<?php
    function &ref_call_user_func_array($callable, $args)
    {
        if(is_scalar($callable))
        {
            // $callable is the name of a function
            $call = $callable;
        }
        else
        {
            if(is_object($callable[0]))
            {
                // $callable is an object and a method name
                $call = "\$callable[0]->{$callable[1]}";
            }
            else
            {
                // $callable is a class name and a static method
                $call = "{$callable[0]}::{$callable[1]}";
            }
        }
        
        // Note because the keys in $args might be strings
        // we do this in a slightly round about way.
        $argumentString = array();
        $argumentKeys = array_keys($args);
        foreach($argumentKeys as $argK)
        {
            $argumentString[] = "\$args[$argumentKeys[$argK]]";
        }
        $argumentString = implode($argumentString, ', ');
        // Note also that eval doesn't return references, so we 
        // work around it in this way...    
        eval("\$result =& {$call}({$argumentString});");
        return $result;
    }
?>

add a note