Definition
The vsprintf() function writes a formatted string to a variable.
Unlike sprintf()
, the arguments in vsprintf()
, are placed in an array. The array elements will be inserted at the percent (%
) signs in the main string. This function works "step-by-step". At the first %
sign, the first array element is inserted, at the second %
sign, the second array element is inserted, etc.
Syntax
vsprintf(format, arg_array)
Parameters
Parameter | Description |
---|---|
format |
Required. Specifies the string and how to format the variables in it. Possible format values:%% - Returns a percent sign%b - Binary number%c - The character according to the ASCII value%d - Signed decimal number (negative, zero or positive)%e - Scientific notation using a lowercase (e.g. 1.2e+2)%E - Scientific notation using a uppercase (e.g. 1.2E+2)%u - Unsigned decimal number (equal to or greather than zero)%f - Floating-point number (local settings aware)%F - Floating-point number (not local settings 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. These are placed between the % and the letter (example %.2f): + (Forces both + and - in front of numbers. By default, only negative numbers are marked)' (Specifies what to use as padding. Default is space. Must be used together with the width specifier. Example: %'x20s (this uses "x" as padding)- (Left-justifies the variable value)[0-9] (Specifies the minimum width held of to the variable value).[0-9] (Specifies the number of decimal digits or maximum string length) |
arg_array |
Required. An array with arguments to be inserted at the % signs in the format string. |
Example
<?php
$popn = 200;
$country = "USA";
$str = vsprintf("There are %u million people in %s.", array($popn, $country));
echo $str;