vsprintf()

vsprintf() — Return a formatted string.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

Operates as sprintf() but accepts an array of arguments, rather than a variable number of arguments.

Signature

vsprintf(string $format, array $values): string

Parameters

Parameter	Type	What it takes
$format	string	An integer followed by a dollar sign $, to specify which number argument to treat in the conversion.
$values	array

Return value

Return array values as a formatted string according to format.

Example

A runnable snippet:

print vsprintf("%04d-%02d-%02d", explode('-', '1988-8-1'));

Output:

1988-08-01

Changelog

Version	Change
8.5.0	A formatter that does not specify a precision now correctly treats it as a precision of 0, instead of incorrectly resetting the precision.
8.0.0	This function no longer returns false on failure.
8.0.0	Throws a ValueError if the number of arguments is zero; previously this function emitted an E_WARNING instead.
8.0.0	Throws a ValueError if [width] is less than zero or bigger than PHP_INT_MAX; previously this function emitted an E_WARNING instead.
8.0.0	Throw a ValueError if [precision] is less than zero or bigger than PHP_INT_MAX; previously this function emitted an E_WARNING instead.
8.0.0	Throws a ValueError when fewer arguments are given than required; previously this function emitted an E_WARNING instead.