Funções anônimas e closures no PHP: a palavra-chave use

Uma função anônima, também chamada de closure, é uma função sem nome. Você escreve function ($param) { ... } onde um valor é esperado: atribui a uma variável, passa para outra função ou retorna. Ela pode levar variáveis do código em volta com use ($var).

<?php
$greet = function (string $name): string {
    return "Hello, $name";
};   // the semicolon ends the assignment

echo $greet('Ada'), "\n";

$greeting = 'Welcome';
$welcome = function (string $name) use ($greeting): string {
    return "$greeting, $name";
};
echo $welcome('Linus'), "\n";

var_dump($greet instanceof Closure);

Toda função anônima é um objeto da classe nativa Closure, e é por isso que ela pode ser guardada, passada adiante e chamada depois com $greet(...).

A palavra-chave use captura por valor

Uma closure não enxerga variáveis de fora sozinha. use ($x) copia o valor de $x para dentro da closure no momento em que a closure é criada, não quando ela roda:

<?php
$discount = 10;

$apply = function (float $price) use ($discount): float {
    return $price - $discount;
};

$discount = 50;            // changed after the closure was created
echo $apply(100), "\n";    // still uses 10

// Several variables
$currency = 'EUR';
$rate = 1.08;
$convert = function (float $usd) use ($rate, $currency): string {
    return number_format($usd / $rate, 2) . " $currency";
};
echo $convert(54), "\n";

use por referência: &$var

use (&$x) dá à closure a própria variável em vez de uma cópia. Mudanças dentro da closure são visíveis fora, e mudanças fora são vistas dentro. É assim que um callback soma num total ou mantém um contador.

<?php
$total = 0;
$addToTotal = function (int $amount) use (&$total): void {
    $total += $amount;
};

$addToTotal(10);
$addToTotal(32);
echo $total, "\n";

// A counter that remembers its state between calls
function makeCounter(): Closure
{
    $count = 0;
    return function () use (&$count): int {
        return ++$count;
    };
}

$next = makeCounter();
echo $next(), $next(), $next(), "\n";

$other = makeCounter();     // its own $count
echo $other(), "\n";

Cada chamada a makeCounter() cria um novo $count, e a closure retornada o mantém vivo depois que a função retornou. É a isso que "closure" se refere: a função se fecha sobre as variáveis de que precisa.

Passar uma closure como callback

Funções como array_map(), array_filter(), usort() e array_walk() recebem uma função como argumento. Uma closure deixa você escrevê-la no lugar, com quantas instruções a tarefa precisar:

<?php
$products = [
    ['name' => 'Laptop', 'price' => 1200, 'stock' => 3],
    ['name' => 'Mouse', 'price' => 25, 'stock' => 0],
    ['name' => 'Monitor', 'price' => 300, 'stock' => 7],
];

$minPrice = 100;
$available = array_filter($products, function ($p) use ($minPrice) {
    return $p['stock'] > 0 && $p['price'] >= $minPrice;
});

usort($available, function ($a, $b) {
    return $b['price'] <=> $a['price'];   // most expensive first
});

$labels = array_map(function ($p) {
    $label = strtoupper($p['name']);
    return "$label ({$p['stock']} left)";
}, $available);

print_r($labels);

Quando o corpo é uma única expressão, uma arrow function como fn($p) => $p['price'] é mais curta e não precisa de use.

Callables: nomes de funções, métodos e strlen(...)

Um parâmetro com o tipo callable aceita mais que closures. Uma string com o nome de uma função, um array com um objeto e o nome de um método, e um array com um nome de classe e um método estático, todos contam. Desde o PHP 8.1, a sintaxe de callable de primeira classe strlen(...) transforma qualquer um deles diretamente numa Closure.

<?php
class Formatter
{
    public function shout(string $s): string { return strtoupper($s) . '!'; }
    public static function whisper(string $s): string { return strtolower($s) . '...'; }
}

$words = ['Hello', 'World'];
$f = new Formatter();

print_r(array_map('strtoupper', $words));                   // function name
print_r(array_map([$f, 'shout'], $words));                  // object method
print_r(array_map([Formatter::class, 'whisper'], $words));  // static method

// PHP 8.1 first-class callable syntax
$len = strlen(...);
$shout = $f->shout(...);
$whisper = Formatter::whisper(...);
echo $len('closure'), ' ', $shout('hey'), ' ', $whisper('PSST'), "\n";

function apply(callable $fn, string $value): string
{
    return $fn($value);
}
echo apply('ucfirst', 'php'), "\n";
var_dump(is_callable('no_such_function'));

A forma (...) é verificada quando a linha roda: um erro de digitação lança um Error ali mesmo. Uma string como 'strtoupr' é só uma string até alguém tentar chamá-la.

Closures dentro de uma classe: $this e static

Uma closure criada dentro de um método tem $this vinculado automaticamente, então pode usar as propriedades do objeto. Marque-a como static function quando ela não precisar de $this, o que também a impede de manter o objeto vivo.

<?php
class Cart
{
    private array $items = [];
    private float $taxRate = 0.2;

    public function add(string $name, float $price): void
    {
        $this->items[$name] = $price;
    }

    public function pricesWithTax(): array
    {
        // $this is available inside the closure
        return array_map(function (float $price): float {
            return round($price * (1 + $this->taxRate), 2);
        }, $this->items);
    }

    public function names(): array
    {
        return array_map(static function (string $name): string {
            return ucfirst($name);
        }, array_keys($this->items));
    }
}

$cart = new Cart();
$cart->add('book', 12.5);
$cart->add('pen', 1.99);
print_r($cart->pricesWithTax());
print_r($cart->names());

Esquecer o use

O bug de closure mais comum é usar uma variável de fora sem listá-la no use. Dentro da closure a variável não existe:

$minAge = 18;
$adults = array_filter($people, function ($p) {
    return $p['age'] >= $minAge;   // $minAge is not in use (...)
});

PHP prints: Warning: Undefined variable $minAge

$minAge é null lá dentro, qualquer idade comparada com >= null é true, e todas as pessoas passam no filtro. Num servidor que esconde avisos, nada avisa você. Adicione a variável ao use:

<?php
$people = [['name' => 'Ada', 'age' => 36], ['name' => 'Tom', 'age' => 12]];
$minAge = 18;

$adults = array_filter($people, function ($p) use ($minAge) {
    return $p['age'] >= $minAge;
});
print_r(array_column($adults, 'name'));

// Or an arrow function, which captures $minAge automatically
$adults2 = array_filter($people, fn($p) => $p['age'] >= $minAge);
print_r(array_column($adults2, 'name'));