YouTip

[ PHP String Reference Manual](#) ## Example Write a formatted string into a variable: [Run Example »](#) * * * ## Definition and Usage The vsprintf() function writes a formatted string into a variable. Unlike sprintf(), the arguments in vsprintf() are placed in an array. The array elements will be inserted into the main string at the percent (%) signs. This function executes step by step. At the first % sign, the first array element is inserted; at the second % sign, the second array element is inserted, and so on. **Note:** If there are more % signs than arguments, you must use placeholders. Placeholders are inserted after the % sign and consist of a number and a "$". See Example 2. **Tip:** Related functions: [fprintf()](#), [vfprintf()](#), [printf()](#), [sprintf()](#), and [vprintf()](#) * * * ## Syntax vsprintf(_format,argarray_) | Parameter | Description | | --- | --- | | _format_ | Required. Specifies the string and how to format the variables within it. Possible format values: * %% - Returns a percent sign % * %b - Binary number * %c - Character corresponding to the ASCII value * %d - Signed decimal number (negative, 0, positive) * %e - Scientific notation (lowercase, e.g., 1.2e+2) * %E - Scientific notation (uppercase, e.g., 1.2E+2) * %u - Unsigned decimal number (greater than or equal to 0) * %f - Floating-point number (locale aware) * %F - Floating-point number (not locale aware) * %g - Shorter of %e and %f * %G - Shorter of %E and %f * %o - Octal number * %s - String * %x - Hexadecimal number (lowercase letters) * %X - Hexadecimal number (uppercase letters) Additional format values. Must be placed between % and the letter (e.g., %.2f): * + (Adds a + or - sign to define the sign of the number. By default, only negative numbers are marked, positive numbers are not) * ' (Specifies what to use for padding. Default is a space. Must be used with a width specifier. Example: %'x20s (uses "x" for padding)) * - (Left-justifies the variable value) * (Specifies the minimum width of the variable value) * . (Specifies the number of decimal places or maximum string length) **Note:** If multiple format values are used, they must be used in the order shown above and cannot be mixed. | | _argarray_ | Required. An array containing the arguments to be inserted into the format string at the % signs. | ## Technical Details | Return Value: | Returns the array values as a formatted string. | | --- | | PHP Version: | 4.1.0+ | * * * ## More Examples ## Example 1 Using the format value %f: [Run Example »](#) ## Example 2 Using placeholders: <?php $number = 123; $txt = vsprintf("With 2 decimals: %1$.2f
With no decimals: %1$u",array($number)); echo $txt; ?> [Run Example »](#) ## Example 3 Using sprintf() to demonstrate all possible format values: <?php $num1 = 123456789; $num2 = -123456789; $char = 50; // The ASCII Character 50 is 2 // Note: The format value "%%" returns a percent sign echo sprintf("%%b = %b",$num1)."
"; // Binary number echo sprintf("%%c = %c",$char)."
"; // The ASCII Character echo sprintf("%%d = %d",$num1)."
"; // Signed decimal number echo sprintf("%%d = %d",$num2)."
"; // Signed decimal number echo sprintf("%%e = %e",$num1)."
"; // Scientific notation (lowercase) echo sprintf("%%E = %E",$num1)."
"; // Scientific notation (uppercase) echo sprintf("%%u = %u",$num1)."
"; // Unsigned decimal number (positive) echo sprintf("%%u = %u",$num2)."
"; // Unsigned decimal number (negative) echo sprintf("%%f = %f",$num1)."
"; // Floating-point number (local settings aware) echo sprintf("%%F = %F",$num1)."
"; // Floating-point number (not local sett aware) echo sprintf("%%g = %g",$num1)."
"; // Shorter of %e and %f echo sprintf("%%G = %G",$num1)."
"; // Shorter of %E and %f echo sprintf("%%o = %o",$num1)."
"; // Octal number echo sprintf("%%s = %s",$num1)."
"; // String echo sprintf("%%x = %x",$num1)."
"; // Hexadecimal number (lowercase) echo sprintf("%%X = %X",$num1)."
"; // Hexadecimal number (uppercase) echo sprintf("%%+d = %+d",$num1)."
"; // Sign specifier (positive) echo sprintf("%%+d = %+d",$num2)."
"; // Sign specifier (negative) ?> [Run Example »](#) ## Example 4 Demonstration of string specifiers: <?php $str1 = "Hello"; $str2 = "Hello world!"; echo vsprintf("[%s]",array($str1))."
"; echo vsprintf("[%8s]",array($str1))."
"; echo vsprintf("[%-8s]",array($str1))."
"; echo vsprintf("[%08s]",array($str1))."
"; echo vsprintf("[%'*8s]",array($str1))."
"; echo vsprintf("[%8.8s]",array($str2))."
"; ?> [Run Example »](#) * * PHP String Reference Manual](#)