(PHP 4, PHP 5, PHP 7, PHP 8)
sprintf — 返回格式化字符串
format
format 字符串通常由零或多个指令组成:普通字符(不包含
%
)——直接复制到结果,转换规范——获取每个参数的结果。
转换规范遵循此原型:
%[argnum$][flags][width][.precision]specifier
.
整数后跟美元符号 $
,用于指定转换中要处理的参数数量。
标志 | 说明 |
---|---|
- |
在指定字段宽度时左对齐,默认右对齐 |
+ |
正数的加号 + 前缀,默认负数的前缀是负号。
|
(space) |
空格填充结果。这是默认设置。 |
0 |
仅用 0 进行左侧数字填充。使用 s 标志符可以右侧填充。
|
' (char) |
用字符(char)填充结果。 |
要么是整数,表示转换结果应该有多少个字符(最少),要么是 *
。如果使用
*
,那么宽度将作为额外的整数值提供,位于格式化符号之前。
小数点 .
,可选的后跟整数或者 *
,其含义取决于格式化符号:
e
、E
、f
、F
标志符:小数点后需要打印的位数(默认是 6)。
g
、G
、h
、H
标志符:这是要打印的最大有效位数。
s
标志符:充当分界点,为字符串设置最大字符限制。
注意: 如果小数点没有明确的精度值,则假设是 0。如果使用
*
,则精度将作为额外的整数值提供,位于格式化符号之前。
标志符 | 说明 |
---|---|
% |
字面意思的百分号字符。不需要参数。 |
b |
参数视为整数并以二进制数字呈现。 |
c |
参数视为整数并以 ASCII 字符呈现。 |
d |
参数视为整数并以(有符号)十进制数字呈现。 |
e |
参数当做科学符号处理(例如 1.2e+2)。 |
E |
与 e 标志符相同,但使用大写字母(例如 1.2E+2)。
|
f |
参数当做浮点数处理且作为浮点数呈现(locale aware)。 |
F |
参数当做浮点数处理且作为浮点数呈现(non-locale aware)。 |
g |
通用格式。 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 |
参数视为整数并以八进制数字来呈现。 |
s |
参数视为字符串来呈现。 |
u |
参数视为整数并以无符号十进制数字呈现。 |
x |
参数视为整数并作为十六进制数字呈现(带小写字母)。 |
X |
参数视为整数并作为十六进制数字呈现(带大写字母)。 |
c
类型标志符忽略填充和宽度
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
变量将会强制转换为适合标志符的类型:
类型 | 标志符 |
---|---|
string | s |
int |
d ,
u ,
c ,
o ,
x ,
X ,
b
|
float |
e ,
E ,
f ,
F ,
g ,
G ,
h ,
H
|
values
返回一个根据格式化字符串 format
生成的字符串。
从 PHP 8.0.0 开始,如果参数个数为零,将抛出 ValueError。在 PHP 8.0.0 之前,会发出 E_WARNING
。
从 PHP 8.0.0 开始,如果 [width]
小于零或大于 PHP_INT_MAX
,则会抛出
ValueError。在 PHP 8.0.0 之前,会发出 E_WARNING
。
从 PHP 8.0.0 开始,如果 [precision]
小于零或大于 PHP_INT_MAX
,则会抛出
ValueError。在 PHP 8.0.0 之前,会发出 E_WARNING
。
从 PHP 8.0.0 开始,当传递的参数少于所需的参数时会抛出 ArgumentCountError。在 PHP 8.0.0 之前,返回 false
并发出 E_WARNING
。
版本 | 说明 |
---|---|
8.0.0 |
此函数失败时不再返回 false 。
|
8.0.0 |
如果参数个数为零则抛出 ValueError;以前该函数则会发出 E_WARNING 。
|
8.0.0 |
如果 [width] 小于零或大于 PHP_INT_MAX ,则抛出 ValueError;以前该函数则会发出 E_WARNING 。
|
8.0.0 |
如果 [precision] 小于零或大于 PHP_INT_MAX ,则抛出 ValueError;以前该函数则会发出 E_WARNING 。
|
8.0.0 |
当传递的参数少于所需的参数时抛出 ArgumentCountError;以前该函数则会发出 E_WARNING 。
|
示例 #1 参数替换
支持按顺序用参数替换格式字符串里的占位符。
<?php
$num = 5;
$location = 'tree';
$format = 'There are %d monkeys in the %s';
echo sprintf($format, $num, $location);
?>
以上示例会输出:
There are 5 monkeys in the tree
假设,我们想把它国际化,在一个单独的文件中创建格式字符串,我们将它重写为:
<?php
$format = 'The %s contains %d monkeys';
echo sprintf($format, $num, $location);
?>
我们现在有一个问题。 格式字符串中占位符的顺序与代码中参数的顺序不匹配。 我们希望保持代码原样,并在格式字符串中简单地指出占位符引用的参数。 我们可以这样写格式化字符串:
<?php
$format = 'The %2$s contains %1$d monkeys';
echo sprintf($format, $num, $location);
?>
另外一个好处是占位符可以重复使用,而无需在代码中添加更多参数。
<?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);
?>
当使用参数替换时,n$
位置指示符 必须紧跟在百分号(%
)之后,在任何其他指示符之前,如下所示。
示例 #2 指定填充字符
<?php
echo sprintf("%'.9d\n", 123);
echo sprintf("%'.09d\n", 123);
?>
以上示例会输出:
......123 000000123
示例 #3 位置说明符与其他说明符
<?php
$format = 'The %2$s contains %1$04d monkeys';
echo sprintf($format, $num, $location);
?>
以上示例会输出:
The tree contains 0005 monkeys
示例 #4 sprintf():零填充整数
<?php
$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);
?>
示例 #5 sprintf():货币格式
<?php
$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
echo $money;
echo "\n";
$formatted = sprintf("%01.2f", $money);
echo $formatted;
?>
以上示例会输出:
123.1 123.10
示例 #6 sprintf():科学记数法
<?php
$number = 362525200;
echo sprintf("%.3e", $number);
?>
以上示例会输出:
3.625e+8