call_user_func_array

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

call_user_func_array — Chama uma função de retorno com um array de parâmetros

Descrição

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

Chama a função de retorno do definida no primeiro parâmetro callback com os parâmetros informados no parâmetro args.

Parâmetros

callback

A função do tipo callable a ser chamada.

args

Os parâmetros a serem passados à função de retorno, como um array.

Se as chaves do array de args forem todas numéricas, elas serão ignoradas e cada elemento será passado à função informada no parâmetro callback como um argumento potencial, em ordem.

Se qualquer chave do array args for uma string, esses elementos serão passados à função informada no parâmetro callback como argumentos nomeados, com o mesmo nome dado pela chave.

É um erro fatal quando uma chave numérica no array do parâmetro args aparece depois de uma chave string, ou se uma chave string não corresponder a nenhum parâmetro da função informada em callback.

Valor Retornado

Retorna o mesmo valor retornado pela função de retorno, ou false em caso de erro.

Registro de Alterações

Versão	Descrição
8.0.0	As chaves de `args` agora serão interpretadas como nomes de parâmetros, ao invés de serem silenciosamente ignorados.

Exemplos

Exemplo #1 Exemplo de call_user_func_array()

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


// Chama a função foobar() com 2 argumentos
call_user_func_array("foobar", array("um", "dois"));

// Chama o método $foo->bar() com 2 argumentos
$foo = new foo;
call_user_func_array(array($foo, "bar"), array("três", "quatro"));
?>

O exemplo acima produzirá algo semelhante a:

foobar recebeu um e dois
foo::bar recebeu três e quatro

Exemplo #2 call_user_func_array() usando espaço de nomes

<?php

namespace Foobar;

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

call_user_func_array(__NAMESPACE__ .'\Foo::test', array('João'));

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

?>

O exemplo acima produzirá algo semelhante a:

Olá, João!
Olá, Felipe!

Exemplo #3 Usando função lambda

<?php

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

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

?>

O exemplo acima produzirá:

int(8)

Exemplo #4 Passando valores por referência

<?php

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

?>

O exemplo acima produzirá:

função mega $a=55
global $bar=55

Exemplo #5 call_user_func_array() usando parâmetros nomeados

<?php
function foobar($primeiro, $segundo) {
    echo __FUNCTION__, " recebeu $primeiro e $segundo\n";
}

// Chama a função foobar() com argumentos nomeados em ordem não posicional
call_user_func_array("foobar", array("segundo" => "dois", "primeiro" => "um"));

// Chama a função foobar() com um argumento nomeado
call_user_func_array("foobar", array("foo", "segundo" => "bar"));

// Erro fatal: Não é possível usar argumento posicional após um argumento nomeado
call_user_func_array("foobar", array("primeiro" => "um", "bar"));

?>

O exemplo acima produzirá algo semelhante a:

foobar recebeu um and dois
foobar recebeu foo and bar

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

Notas

Nota:
Callbacks registrados com funções como call_user_func() e call_user_func_array() não serão chamados se houver uma exceção não capturada que foi lançada em um callback anterior.

Veja Também

call_user_func() - Chama a função de retorno informada no primeiro parâmetro
ReflectionFunction::invokeArgs() - Invoca argumentos de função
ReflectionMethod::invokeArgs() - Invoca argumentos

Melhore Esta Página

Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema

＋adicione uma nota

Notas Enviadas por Usuários (em inglês) 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 ¶

20 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;
    }
?>

＋adicione uma nota