<HTML
><HEAD
><TITLE
>sprintf</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="String functions"
HREF="ref.strings.html"><LINK
REL="PREVIOUS"
TITLE="soundex"
HREF="function.soundex.html"><LINK
REL="NEXT"
TITLE="sscanf"
HREF="function.sscanf.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.soundex.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.sscanf.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.sprintf"
></A
>sprintf</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN90657"
></A
><P
> (PHP 3, PHP 4 )</P
>sprintf -- Return a formatted string</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN90660"
></A
><H2
>Description</H2
>string <B
CLASS="methodname"
>sprintf</B
> ( string format [, mixed args])<BR
></BR
><P
> Returns a string produced according to the formatting string
<TT
CLASS="parameter"
><I
>format</I
></TT
>.
</P
><P
> The format string is composed of zero or more directives:
ordinary characters (excluding <TT
CLASS="literal"
>%</TT
>) that are
copied directly to the result, and <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>conversion
specifications</I
></SPAN
>, each of which results in fetching its
own parameter. This applies to both <B
CLASS="function"
>sprintf()</B
>
and <A
HREF="function.printf.html"
><B
CLASS="function"
>printf()</B
></A
>.
</P
><P
> Each conversion specification consists of a percent sign
(<TT
CLASS="literal"
>%</TT
>), followed by one or more of these
elements, in order:
<P
></P
><OL
TYPE="1"
><LI
><P
> An optional <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>padding specifier</I
></SPAN
> that says
what character will be used for padding the results to the
right string size. This may be a space character or a
<TT
CLASS="literal"
>0</TT
> (zero character). The default is to pad
with spaces. An alternate padding character can be specified
by prefixing it with a single quote (<TT
CLASS="literal"
>'</TT
>).
See the examples below.
</P
></LI
><LI
><P
> An optional <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>alignment specifier</I
></SPAN
> that says
if the result should be left-justified or right-justified.
The default is right-justified; a <TT
CLASS="literal"
>-</TT
>
character here will make it left-justified.
</P
></LI
><LI
><P
> An optional number, a <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>width specifier</I
></SPAN
>
that says how many characters (minimum) this conversion should
result in.
</P
></LI
><LI
><P
> An optional <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>precision specifier</I
></SPAN
> that says
how many decimal digits should be displayed for floating-point
numbers. This option has no effect for other types than
<A
HREF="language.types.float.html"
><B
CLASS="type"
>float</B
></A
>. (Another function useful for formatting numbers is
<A
HREF="function.number-format.html"
><B
CLASS="function"
>number_format()</B
></A
>.)
</P
></LI
><LI
><P
> A <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>type specifier</I
></SPAN
> that says what type the
argument data should be treated as. Possible types:
<P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
> <TT
CLASS="literal"
>%</TT
> - a literal percent character. No
argument is required.
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>b</TT
> - the argument is treated as an
integer, and presented as a binary number.
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>c</TT
> - the argument is treated as an
integer, and presented as the character with that ASCII
value.
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>d</TT
> - the argument is treated as an
integer, and presented as a (signed) decimal number.
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>u</TT
> - the argument is treated as an
integer, and presented as an unsigned decimal number.
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>f</TT
> - the argument is treated as a
<A
HREF="language.types.float.html"
><B
CLASS="type"
>float</B
></A
>, and presented as a floating-point number.
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>o</TT
> - the argument is treated as an
integer, and presented as an octal number.
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>s</TT
> - the argument is treated as and
presented as a string.
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>x</TT
> - the argument is treated as an integer
and presented as a hexadecimal number (with lowercase
letters).
</TD
></TR
><TR
><TD
> <TT
CLASS="literal"
>X</TT
> - the argument is treated as an integer
and presented as a hexadecimal number (with uppercase
letters).
</TD
></TR
></TBODY
></TABLE
><P
></P
>
</P
></LI
></OL
>
</P
><P
> As of PHP version 4.0.6 the format string supports argument
numbering/swapping. Here is an example:
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN90724"
></A
><P
><B
>Example 1. Argument swapping</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>$format = "There are %d monkeys in the %s";
printf($format,$num,$location);</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
This might output, "There are 5 monkeys in the tree". But
imagine we are creating a format string in a separate file,
commonly because we would like to internationalize it and we
rewrite it as:
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN90727"
></A
><P
><B
>Example 2. Argument swapping</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>$format = "The %s contains %d monkeys";
printf($format,$num,$location);</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
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:
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN90730"
></A
><P
><B
>Example 3. Argument swapping</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>$format = "The %2\$s contains %1\$d monkeys";
printf($format,$num,$location);</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
An added benefit here is that you can repeat the placeholders without
adding more arguments in the code. For example:
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN90733"
></A
><P
><B
>Example 4. Argument swapping</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>$format = "The %2\$s contains %1\$d monkeys.
That's a nice %2\$s full of %1\$d monkeys.";
printf($format, $num, $location);</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
</P
><P
> See also <A
HREF="function.printf.html"
><B
CLASS="function"
>printf()</B
></A
>,
<A
HREF="function.sscanf.html"
><B
CLASS="function"
>sscanf()</B
></A
>, <A
HREF="function.fscanf.html"
><B
CLASS="function"
>fscanf()</B
></A
>,
<A
HREF="function.vsprintf.html"
><B
CLASS="function"
>vsprintf()</B
></A
>, and
<A
HREF="function.number-format.html"
><B
CLASS="function"
>number_format()</B
></A
>.
</P
></DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN90742"
></A
><H2
>Examples</H2
><P
> <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN90745"
></A
><P
><B
>Example 5. <B
CLASS="function"
>sprintf()</B
>: zero-padded integers</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN90749"
></A
><P
><B
>Example 6. <B
CLASS="function"
>sprintf()</B
>: formatting currency</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
// echo $money will output "123.1";
$formatted = sprintf("%01.2f", $money);
// echo $formatted will output "123.10"</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.soundex.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.sscanf.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>soundex</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.strings.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>sscanf</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
distrib
>
Mandriva
>
9.1
>
ppc
>
media
>
main
>
by-pkgid
>
0afeee9cca140e167a996902b9a677c5
>
files
>
2510
