(PHP 4, PHP 5, PHP 7, PHP 8)
sprintf — Return a formatted string
Returns a string produced according to the formatting string format.
format A string de formato é composta de zero ou mais diretivas: caracteres comuns (excluindo %) que são copiados diretamente para o resultado e especificações de conversão, cada uma das quais resulta na busca de seu próprio parâmetro.
Uma especificação de conversão segue este protótipo: %[argnum$][flags][width][.precision]especificador.
Um número inteiro seguido por um cifrão $, para especificar qual o número de argumento a tratar na conversão.
| Flag | Descrição |
|---|---|
- | Justificar à esquerda dentro da largura de campo especificada; A justificação à direita é o padrão. |
+ | Prefixa números positivos com um sinal de mais +; Por padrão, apenas números negativos são prefixados com um sinal negativo. |
| Preenche o resultado com espaços. Este é o padrão. |
0 | Preenche números com zeros apenas à esquerda. Com os especificadores s, também pode preencher com zeros à direita. |
'(char) | Preenche o resultado com o caractere (char). |
Um número inteiro que define em quantos caracteres (mínimo) esta conversão deve resultar, ou *. Se * for usado, a largura será fornecida como um valor inteiro adicional precedendo aquele formatado pelo especificador.
Um ponto . opcionalmente seguido por um número inteiro ou *, cujo significado depende do especificador:
e, E, f e F: este é o número de dígitos a serem impressos após o ponto decimal (por padrão, é 6). g, G, h e H: este é o número máximo de dígitos significativos a serem impressos. s: atua como um ponto de corte, definindo um limite máximo de caracteres para a string. Nota: Se o ponto for especificado sem um valor explícito para precisão, 0 é assumido. Se
*for usado, a precisão é fornecida como um valor inteiro adicional precedendo aquele formatado pelo especificador.
| Especificador | Descrição |
|---|---|
% | Um caractere literal de porcentagem. Nenhum argumento é necessário. |
b | O argumento é tratado como um número inteiro e apresentado como um número binário. |
c | O argumento é tratado como um número inteiro e apresentado como o caractere com aquele código ASCII. |
d | O argumento é tratado como um número inteiro e apresentado como um número decimal (com sinal). |
e | O argumento é tratado como notação científica (por exemplo, 1.2e+2). |
E | Como o especificador e, mas usa letra maiúscula (por exemplo, 1.2E+2). |
f | O argumento é tratado como um float e apresentado como um número de ponto flutuante (com reconhecimento da localidade). |
F | O argumento é tratado como um float e apresentado como um número de ponto flutuante (sem reconhecimento da localidade). |
g | Formato geral. Deixa P igual à precisão se for diferente de zero, 6 se a precisão for omitida, ou 1 se a precisão for zero. Então, se uma conversão com estilo E tivesse um expoente de X: Se P > X ≥ −4, a conversão é com estilo f e precisão P − (X + 1). Caso contrário, a conversão é com estilo e e precisão P − 1. |
G | Como o especificador g, mas usa E e f. |
h | Como o especificador g, mas usa F. Disponível a partir do PHP 8.0.0. |
H | Como o especificador g, mas usa E e F. Disponível a partir do PHP 8.0.0. |
o | O argumento é tratado como um número inteiro e apresentado como um número octal. |
s | O argumento é tratado e apresentado como uma string. |
u | O argumento é tratado como um número inteiro e apresentado como um número decimal sem sinal. |
x | O argumento é tratado como um número inteiro e apresentado como um número hexadecimal (com letras minúsculas). |
X | O argumento é tratado como um número inteiro e apresentado como um número hexadecimal (com letras maiúsculas). |
O especificador de tipo c ignora preenchimento e largura.
Tentar usar uma combinação dos especificadores de string e largura com conjuntos de caracteres que requerem mais de um byte por caractere pode resultar em resultados inesperados.
As variáveis serão forçadas a um tipo adequado para o especificador:
| Tipo | Especificadores |
|---|---|
| string | s |
| int | d, u, c, o, x, X, b |
| float | e, E, f, F, g, G, h, H |
values Returns a string produced according to the formatting string format.
A partir do PHP 8.0.0, um erro ValueError será lançado se o número de argumentos for zero. Antes do PHP 8.0.0, um E_WARNING era emitido.
A partir do PHP 8.0.0, um erro ValueError será lançado se [width] for menor que zero ou maior que PHP_INT_MAX. Antes do PHP 8.0.0, um E_WARNING era emitido.
A partir do PHP 8.0.0, um erro ValueError será lançado se [precision] for menor que zero ou maior que PHP_INT_MAX. Antes do PHP 8.0.0, um E_WARNING era emitido.
A partir do PHP 8.0.0, um erro ArgumentCountError será lançado quando menos argumentos do que o necessário forem fornecidos. Antes do PHP 8.0.0, false era retornado e um E_WARNING era emitido.
| Versão | Descrição |
|---|---|
| 8.0.0 | Esta função não retorna mais false em caso de falha. |
| 8.0.0 | Lança um erro ValueError se o número de argumentos for zero; anteriormente, esta função emitia um E_WARNING. |
| 8.0.0 | Lança um erro ValueError se [width] for menor que zero ou maior que PHP_INT_MAX; anteriormente, esta função emitia um E_WARNING. |
| 8.0.0 | Lança um erro ValueError se [precision] for menor que zero ou maior que PHP_INT_MAX; anteriormente, esta função emitia um E_WARNING. |
| 8.0.0 | Lança um erro ArgumentCountError quando menos argumentos do que o necessário são fornecidos; anteriormente, esta função emitia um E_WARNING. |
Exemplo #1 Argument swapping
The format string supports argument numbering/swapping.
<?php
$num = 5;
$location = 'tree';
$format = 'There are %d monkeys in the %s';
echo sprintf($format, $num, $location);
?>O exemplo acima produzirá:
There are 5 monkeys in the tree
However imagine we are creating a format string in a separate file, commonly because we would like to internationalize it and we rewrite it as:
<?php
$format = 'The %s contains %d monkeys';
echo sprintf($format, $num, $location);
?>We now have a problem. The order of the placeholders in the format string does not match the order of the arguments in the code. We would like to leave the code as is and simply indicate in the format string which arguments the placeholders refer to. We would write the format string like this instead:
<?php
$format = 'The %2$s contains %1$d monkeys';
echo sprintf($format, $num, $location);
?>An added benefit is that placeholders can be repeated without adding more arguments in the code.
<?php
$format = 'The %2$s contains %1$d monkeys.
That\'s a nice %2$s full of %1$d monkeys.';
echo sprintf($format, $num, $location);
?> When using argument swapping, the n$position specifier must come immediately after the percent sign (%), before any other specifiers, as shown below.
Exemplo #2 Specifying padding character
<?php
echo sprintf("%'.9d\n", 123);
echo sprintf("%'.09d\n", 123);
?>O exemplo acima produzirá:
......123 000000123
Exemplo #3 Position specifier with other specifiers
<?php
$format = 'The %2$s contains %1$04d monkeys';
echo sprintf($format, $num, $location);
?>O exemplo acima produzirá:
The tree contains 0005 monkeys
Exemplo #4 sprintf(): zero-padded integers
<?php
$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);
?>Exemplo #5 sprintf(): formatting currency
<?php
$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
echo $money;
echo "\n";
$formatted = sprintf("%01.2f", $money);
echo $formatted;
?>O exemplo acima produzirá:
123.1 123.10
Exemplo #6 sprintf(): scientific notation
<?php
$number = 362525200;
echo sprintf("%.3e", $number);
?>O exemplo acima produzirá:
3.625e+8