sprintf

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

sprintfDevuelve una string formateada

Descripción

sprintf(string $format, mixed ...$values): string

Devuelve una string formateada, con el formato format, utilizando los argumentos args.

Parámetros

format

The format string is composed of zero or more directives: ordinary characters (excluding %) that are copied directly to the result and conversion specifications, each of which results in fetching its own parameter.

A conversion specification follows this prototype: %[argnum$][flags][width][.precision]specifier.

Argnum

An integer followed by a dollar sign $, to specify which number argument to treat in the conversion.

Flags

Flag Descripción
- Left-justify within the given field width; Right justification is the default
+ Prefix positive numbers with a plus sign +; Default only negative are prefixed with a negative sign.
(space) Pads the result with spaces. This is the default.
0 Only left-pads numbers with zeros. With s specifiers this can also right-pad with zeros.
'(char) Pads the result with the character (char).

Width

Either an integer that says how many characters (minimum) this conversion should result in, or *. If * is used, then the width is supplied as an additional integer value preceding the one formatted by the specifier.

Precision

A period . optionally followed by either an integer or *, whose meaning depends on the specifier:

  • For e, E, f and F specifiers: this is the number of digits to be printed after the decimal point (by default, this is 6).
  • For g, G, h and H specifiers: this is the maximum number of significant digits to be printed.
  • For s specifier: it acts as a cutoff point, setting a maximum character limit to the string.

Nota: If the period is specified without an explicit value for precision, 0 is assumed. If * is used, the precision is supplied as an additional integer value preceding the one formatted by the specifier.

Specifiers
Specifier Descripción
% A literal percent character. No argument is required.
b The argument is treated as an integer and presented as a binary number.
c The argument is treated as an integer and presented as the character with that ASCII.
d The argument is treated as an integer and presented as a (signed) decimal number.
e The argument is treated as scientific notation (e.g. 1.2e+2).
E Like the e specifier but uses uppercase letter (e.g. 1.2E+2).
f The argument is treated as a float and presented as a floating-point number (locale aware).
F The argument is treated as a float and presented as a floating-point number (non-locale aware).
g

General format.

Let P equal the precision if nonzero, 6 if the precision is omitted, or 1 if the precision is zero. Then, if a conversion with style E would have an exponent of X:

If P > X ≥ −4, the conversion is with style f and precision P − (X + 1). Otherwise, the conversion is with style e and precision P − 1.

G Like the g specifier but uses E and f.
h Like the g specifier but uses F. Available as of PHP 8.0.0.
H Like the g specifier but uses E and F. Available as of PHP 8.0.0.
o The argument is treated as an integer and presented as an octal number.
s The argument is treated and presented as a string.
u The argument is treated as an integer and presented as an unsigned decimal number.
x The argument is treated as an integer and presented as a hexadecimal number (with lowercase letters).
X The argument is treated as an integer and presented as a hexadecimal number (with uppercase letters).

Advertencia

The c type specifier ignores padding and width.

Advertencia

Attempting to use a combination of the string and width specifiers with character sets that require more than one byte per character may result in unexpected results.

Variables will be co-erced to a suitable type for the specifier:

Type Handling
Type Specifiers
string s
int d, u, c, o, x, X, b
float e, E, f, F, g, G, h, H

values

Valores devueltos

Devuelve una chaîne de caractères creada siguiendo el formato format.

Errores/Excepciones

As of PHP 8.0.0, a ValueError is thrown if the number of arguments is zero. Prior to PHP 8.0.0, a E_WARNING was emitted instead.

As of PHP 8.0.0, a ValueError is thrown if [width] is less than zero or bigger than PHP_INT_MAX. Prior to PHP 8.0.0, a E_WARNING was emitted instead.

As of PHP 8.0.0, a ValueError is thrown if [precision] is less than zero or bigger than PHP_INT_MAX. Prior to PHP 8.0.0, a E_WARNING was emitted instead.

As of PHP 8.0.0, a ArgumentCountError is thrown when less arguments are given than required. Prior to PHP 8.0.0, false was returned and a E_WARNING emitted instead.

Historial de cambios

Versión Descripción
8.0.0 This function no longer returns false on failure.
8.0.0 Throw a ValueError if the number of arguments is zero; previously this function emitted a E_WARNING instead.
8.0.0 Throw a ValueError if [width] is less than zero or bigger than PHP_INT_MAX; previously this function emitted a 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 a E_WARNING instead.
8.0.0 Throw a ArgumentCountError when less arguments are given than required; previously this function emitted a E_WARNING instead.

Ejemplos

Ejemplo #1 Intercambio de argumentos

La string de formato soporta la numeración y el intercambio de argumentos.

<?php
$num
= 5;
$location = 'bananero';

$format = 'Hay %d monos en el %s';
echo
sprintf($format, $num, $location);
?>

El resultado del ejemplo sería:

Hay 5 monos en el bananero

Pero imagine que la string de formato sea creada en un script separado, como una biblioteca: esto ocurre cuando se debe internacionalizar una aplicación. Según el idioma, puede que sea necesario escribir:

Ejemplo #2 Orden incorrecto de los argumentos

La string de formato soporta la numeración y el intercambio de argumentos.

<?php
$num
= 5;
$location = 'árbol';
$format = 'El %s tiene %d monos';

echo
sprintf($format, $num, $location);
?>

Ahora tenemos un problema. El orden de los argumentos ha sido cambiado, y ya no corresponde al orden de los argumentos en el script PHP. Se desea dejar el código PHP intacto, pero simplemente indicar en la string de formato el orden en el que los argumentos deben ser utilizados. La string de formato puede ser reescrita así:

Ejemplo #3 Uso del marcador de orden

<?php
$num
= 5;
$location = 'árbol';

$format = 'El %2$s tiene %1$d monos';
echo
sprintf($format, $num, $location);
?>

Una de las ventajas es que los parámetros ficticios pueden ser repetidos sin añadir más argumentos en el código.

Ejemplo #4 Repetición del marcador

<?php
$format
= 'El %2$s tiene %1$d monos.
Es un hermoso %2$s con %1$d monos.'
;
echo
sprintf($format, $num, $location);
?>

Al utilizar el mecanismo de intercambio de argumentos, el especificador de posición n$ debe ocurrir inmediatamente después del signo de porcentaje(%), antes de cualquier otro especificador, como en el siguiente ejemplo.

Ejemplo #5 Especificación del carácter de relleno

<?php
echo sprintf("%'.9d\n", 123);
echo
sprintf("%'.09d\n", 123);
?>

El resultado del ejemplo sería:

......123
000000123

Ejemplo #6 Especificador de posición con otros especificadores

<?php
$format
= 'El %2$s contiene %1$04d monos';
echo
sprintf($format, $num, $location);
?>

El resultado del ejemplo sería:

El árbol contiene 0005 monos

Ejemplo #7 sprintf(): entero sin espacios

<?php
$year
= 2005;
$month = 5;
$day = 6;

$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);
echo
$isodate;
?>

Ejemplo #8 sprintf(): formateo de divisas

<?php
$money1
= 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
echo
$money, PHP_EOL;

$formatted = sprintf("%01.2f", $money);
echo
$formatted, PHP_EOL;
?>

El resultado del ejemplo sería:

123.1
123.10

Ejemplo #9 sprintf(): notación científica

<?php
$number
= 362525200;

echo
sprintf("%.3e", $number), PHP_EOL;
?>

El resultado del ejemplo sería:

3.625e+8

Ver también

  • printf() - Muestra una string formateada
  • fprintf() - Escribe una cadena formateada en un flujo
  • vprintf() - Muestra una string formateada
  • vsprintf() - Devuelve una string formateada
  • vfprintf() - Escribe una cadena formateada en un flujo
  • sscanf() - Analiza una cadena utilizando un formato
  • fscanf() - Analiza un archivo según un formato
  • number_format() - Formatea un número para su visualización
  • date() - Da formato a una marca de tiempo de Unix (Unix timestamp)