printf

(PHP 4, PHP 5, PHP 7, PHP 8)

printf — Выводит отформатированную строку

Описание

printf(string $format, mixed ...$values): int

Выводит строку, отформатированную в соответствии с аргументом format.

Список параметров

format

Строка формата состоит из нуля или более директив: обычные символы (за исключением %), которые просто выводятся без изменения и спецификаторы преобразования, каждый из которых требует передачи своего параметра.

Спецификаторы преобразования имеют следующий формат: %[argnum$][flags][width][.precision]specifier.

Argnum

Целое число, за которым следует знак доллара $, чтобы указать, какой числовой аргумент обрабатывать при преобразовании.

**Флаги**
Флаг	Описание
`-`	Выравнивание по левому краю в пределах заданной ширины поля; По умолчанию выравнивание происходит по правому краю.
`+`	Печатает плюс `+` у не отрицательных чисел; По умолчанию знак печатается только у отрицательных чисел.
(space)	Дополняет результат пробелами. Это поведение по умолчанию.
`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`	Аргумент считается за число с плавающей точкой (с учётом локали).
`F`	Аргумент считается за число с плавающей точкой (без учёта локали).
`g`	Общий формат. Пусть P равно точности, если она не равно нулю, 6 — если точность не задана и 1, если точность задана как 0. Тогда, если преобразование со стилем "E" будет иметь показатель степени X: Если P > X ≥ −4, преобразование будет в стиле "f" и точность будет P − (X + 1). В обратном случае, преобразование будет в стиле "e" и точность будет P − 1.
`G`	Аналогично спецификатору `g`, но использует `E` и `f`.
`h`	Аналогично спецификатору `g`, но использует `F`. Доступен с PHP 8.0.0.
`H`	Аналогично спецификатору `g`, но использует `E` и `F`. Доступен с PHP 8.0.0.
`o`	Аргумент рассматривается как целое число и печатается в восьмеричном представлении.
`s`	Аргумент рассматривается и печатается как строка.
`u`	Аргумент рассматривается как целое число и печатается как беззнаковое целое число.
`x`	Аргумент рассматривается как целое число и печатается в шестнадцатеричном представлении (буквы будут в нижнем регистре).
`X`	Аргумент рассматривается как целое число и печатается в шестнадцатеричном представлении (буквы будут в верхнем регистре).

Внимание

Спецификатор c игнорирует значения ширины и дополнения

Внимание

Попытка использовать спецификаторы с указанием ширины для строки в многобайтовой кодировке может привести к неожиданным результатам.

Переменные будут приведены к подходящему для спецификатора типу:

**Обработка типов**
Тип	Спецификатор
string	`s`
int	`d`, `u`, `c`, `o`, `x`, `X`, `b`
float	`e`, `E`, `f`, `F`, `g`, `G`, `h`, `H`

values

Возвращаемые значения

Возвращает длину выводимой строки.

Ошибки

Начиная с 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 вместо этого выдавалась ошибка уровня E_WARNING.

Список изменений

Версия	Описание
8.0.0	Функция больше не возвращает `false` в случае возникновения ошибки.
8.0.0	Выбрасывает исключение ValueError, если количество аргументов равно нулю; ранее функция выдавала ошибку уровня `E_WARNING`.
8.0.0	Выбрасывает исключение ValueError, если `[width]` меньше нуля или больше `PHP_INT_MAX`; ранее функция выдавала ошибку уровня `E_WARNING`.
8.0.0	Выбрасывает исключение ValueError, если `[precision]` меньше нуля или больше `PHP_INT_MAX`; ранее функция выдавала ошибку уровня `E_WARNING`.
8.0.0	Выбрасывает исключение ArgumentCountError, если аргументов задано меньше, чем требуется; ранее функция выдавала ошибку уровня `E_WARNING`.

Примеры

Пример #1 printf(): различные примеры

<?php
$n =  43951789;
$u = -43951789;
$c = 65; // ASCII 65 is 'A'

// двойной %% печатает единичный символ '%'
printf("%%b = '%b'\n", $n); // бинарное представление
printf("%%c = '%c'\n", $c); // печатает символ ascii, аналогично функции chr()
printf("%%d = '%d'\n", $n); // целочисленное представление
printf("%%e = '%e'\n", $n); // научная нотация
printf("%%u = '%u'\n", $n); // положительное целое в беззнаковом представлении
printf("%%u = '%u'\n", $u); // отрицательное целое в беззнаковом представлении
printf("%%f = '%f'\n", $n); // представление в виде числа с плавающей точкой
printf("%%o = '%o'\n", $n); // восмеричное представление
printf("%%s = '%s'\n", $n); // строковое представление
printf("%%x = '%x'\n", $n); // шеснадцатеричное представление в нижнем регистре
printf("%%X = '%X'\n", $n); // шеснадцатеричное представление в верхнем регистре

printf("%%+d = '%+d'\n", $n); // знак у положительного целого
printf("%%+d = '%+d'\n", $u); // знак у отрицательного целого
?>

Результат выполнения приведённого примера:

%b = '10100111101010011010101101'
%c = 'A'
%d = '43951789'
%e = '4.39518e+7'
%u = '43951789'
%u = '4251015507'
%f = '43951789.000000'
%o = '247523255'
%s = '43951789'
%x = '29ea6ad'
%X = '29EA6AD'
%+d = '+43951789'
%+d = '-43951789'

Пример #2 printf(): спецификаторы строки

<?php
$s = 'monkey';
$t = 'many monkeys';

printf("[%s]\n",        $s); // стандартный вывод
printf("[%10s]\n",      $s); // выравнивание вправо с пробелами
printf("[%-10s]\n",     $s); // выравнивание влево с пробелами
printf("[%010s]\n",     $s); // строка дополняется нулями слева
printf("[%'#10s]\n",    $s); // строка дополняется пользовательским символом '#'
printf("[%'#*s]\n", 10, $s); // укажите ширину отступа в качестве дополнительного аргумента
printf("[%10.9s]\n",    $t); // выравнивание вправо с отсечкой в 9 символов
printf("[%-10.9s]\n",   $t); // выравнивание влево с отсечкой в 9 символов
?>

Результат выполнения приведённого примера:

[monkey]
[    monkey]
[monkey    ]
[0000monkey]
[####monkey]
[####monkey]
[ many monk]
[many monk ]

Смотрите также

print - Выводит строку
sprintf() - Возвращает отформатированную строку
fprintf() - Записывает отформатированную строку в поток
vprintf() - Выводит отформатированную строку
vsprintf() - Возвращает отформатированную строку
vfprintf() - Записывает отформатированную строку в поток
sscanf() - Разбирает строку в соответствии с заданным форматом
fscanf() - Обрабатывает данные из файла в соответствии с форматом
number_format() - Форматирует число с разделением групп
date() - Форматирует временную метку Unix
flush() - Сбрасывает системный буфер вывода

add a note

User Contributed Notes 17 notes

down

dhosek at excite dot com ¶

24 years ago


Be careful:

printf ("(9.95 * 100) = %d \n", (9.95 * 100));



'994'



First %d converts a float to an int by truncation.



Second floats are notorious for tiny little rounding errors.

down

php at mole dot gnubb dot net ¶

19 years ago


[Editor's Note: Or just use vprintf...]



If you want to do something like <?php printf('There is a difference between %s and %s', array('good', 'evil')); ?> (this doesn't work)  instead of <?php printf('There is a difference between %s and %s', 'good', 'evil'); ?> you can use this function:



<?php

function printf_array($format, $arr)

{

    return call_user_func_array('printf', array_merge((array)$format, $arr));

}

?>



Use it the following way:

<?php

$goodevil = array('good', 'evil');

printf_array('There is a difference between %s and %s', $goodevil);

?>

and it will print:

There is a difference between good and evil

down

-2

deekayen at hotmail dot com ¶

23 years ago


You can use this function to format the decimal places in a number:



$num = 2.12;

printf("%.1f",$num);



prints:



2.1



see also: number_format()

down

-1

Mario M. Junior ¶

2 years ago


To provide a more user-friendly interface, you can use colors when printing text in the terminal.

p('Ordinary text.');
p('Warning: Check this out...', 'info');
p('Ops! Something went wrong.', 'error');
p('Yeah... done!', 'success');

function p($text, $style = '', $newLine = true) {

    $styles = array(
        'success' => "\033[0;32m%s\033[0m",
        'error'   => "\033[31;31m%s\033[0m",
        'info'    => "\033[33;33m%s\033[0m",

        'Black'    => "\033[0;30m%s\033[0m",
        'Red'      => "\033[0;31m%s\033[0m",
        'Green'    => "\033[0;32m%s\033[0m",
        'Yellow'   => "\033[0;33m%s\033[0m",
        'Blue'     => "\033[0;34m%s\033[0m",
        'Purple'   => "\033[0;35m%s\033[0m",
        'Cyan'     => "\033[0;36m%s\033[0m",
        'Gray'     => "\033[0;37m%s\033[0m",
        'Graphite' => "\033[1;30m%s\033[0m",

        'Bold Red'    => "\033[1;31m%s\033[0m",
        'Bold Green'  => "\033[1;32m%s\033[0m",
        'Bold Yellow' => "\033[1;33m%s\033[0m",
        'Bold Blue'   => "\033[1;34m%s\033[0m",
        'Bold Purple' => "\033[1;35m%s\033[0m",
        'Bold Cyan'   => "\033[1;36m%s\033[0m",
        'Bold White'  => "\033[1;37m%s\033[0m",

        'Bg Black'  => "\033[40;1;37m%s\033[0m",
        'Bg Red'    => "\033[41;1;37m%s\033[0m",
        'Bg Green'  => "\033[42;1;37m%s\033[0m",
        'Bg Yellow' => "\033[43;1;37m%s\033[0m",
        'Bg Blue'   => "\033[44;1;37m%s\033[0m",
        'Bg Purple' => "\033[45;1;37m%s\033[0m",
        'Bg Cyan'   => "\033[46;1;37m%s\033[0m",
        'Bg Gray'   => "\033[47;1;37m%s\033[0m",

        'Underscore' => "\033[4;37m%s\033[0m",
        'Inverted'   => "\033[7;37m%s\033[0m",
        'Blink'      => "\033[5;37m%s\033[0m",
    );

    $format = '%s';

    if (isset($styles[$style])) {
        $format = $styles[$style];
    }

    if ($newLine) {
        $format .= PHP_EOL;
    }

    printf($format, $text);
}

down

-3

maybird99 at yahoo dot com ¶

22 years ago


instead of writing a function to round off a float (let's call it 'x') accurately, it's much easier to add a small number to x and then truncate it...
For example: if you want to round off to the nearest integer, just add 0.5 to x and then truncate it. if x=12.6, then it would calculate 13.1, and truncate it to 13. If x=14.4, it would calculate 14.9 and truncate it to 14.

down

-15

spiffytech at gmail dot com ¶

12 years ago


Be careful when relying on typecasting with printf(). For example,

    printf("%d", "17,999") 

returns "17".

down

-11

shepard at ameth dot org ¶

23 years ago


Be sure that the output channel is available to write on before executing printf()!  Some functions in classes available from various sources (in my case, DB_Sql::query() in PHPLIB) assume that printing will work, even after the default output stream has been closed.  



For me the issue was most notable in PHP4 session management when I was creating my own sess_write() handler.  Since I was unable to find any function that checks for the output stream that printf() uses, I just had to drop the crazy use of the printf(). (does some function already exist to check for the presence of an output stream?)

down

-7

steve at myschoolsystems dot com ¶

3 years ago


To format a dollar value as in $123.00 that may otherwise look like $123  use this

print ('$');                    // the dollar sign in front of our answer
printf ('%.2f',$price);

down

-14

eugenew at starhub dot net dot sg ¶

21 years ago


If anyone is looking for writing a quine using printf(),
this is my example:

<?php $f='<?php $f=%c%s%c; printf($f,39,$f,39); ?>'; printf($f,39,$f,39); ?>

This also helps those who are new to printf() see one way of using the 'mixed args' part, rather than just a single argument as in most examples I've seen.

down

-17

ezislis at mail dot ru ¶

22 years ago


be careful with integers, they cant hold large values.

printf("%d",10023123553.45634663);
will print out: 1433188961 
and
printf("%.0f",10023123553.45634663);
will print out: 10023123553

down

-14

RS ¶

8 years ago


If your missing features such as "-"*100 to print a single character multiple times you can use the slightly longer and less readable PHP equivalent printf("%'-100s",""); and sprint("%'-100s","").

down

-18

dalu at uni SPAMHAM dot de ¶

21 years ago


copypasted from msdn

A format specification, which consists of optional and required fields, has the following form:

%[flags] [width] [.precision] [{h | l | I64 | L}]type

Each field of the format specification is a single character or a number signifying a particular format option. The simplest format specification contains only the percent sign and a type character (for example, %s). If a percent sign is followed by a character that has no meaning as a format field, the character is copied to stdout. For example, to print a percent-sign character, use %%.

The optional fields, which appear before the type character, control other aspects of the formatting, as follows: 

type 
Required character that determines whether the associated argument is interpreted as a character, a string, or a number (see the printf Type Field Characters table. 
flags 
Optional character or characters that control justification of output and printing of signs, blanks, decimal points, and octal and hexadecimal prefixes (see the Flag Characters table). More than one flag can appear in a format specification. 
width 
Optional number that specifies the minimum number of characters output (see printf Width Specification). 
precision 
Optional number that specifies the maximum number of characters printed for all or part of the output field, or the minimum number of digits printed for integer values (see the How Precision Values Affect Type table). 
h | l | I64 | L 
Optional prefixes to type-that specify the size of argument (see the Size Prefixes for printf and wprintf Format-Type Specifiers table).

down

-26

creating dot www at gmail dot com ¶

9 years ago


Why rounding is not same as for round()?

Try this code:

<?php
printf("%.02lf\n", 1.035);
printf("%.02lf\n", round(1.035, 2));
?>
Result:
1.03
1.04

In my opion it should be:
1.04
1.04

Why is that?

down

-22

sam[NOSPAM] at [NOSPAM]kingdomfaith dot com ¶

22 years ago


I don't know if this is useful to anyone, but here goes! Example for using the printf function to output an object.

class person
{
    var $name = "";
    function name($newname = NULL)
    {
        if(! is_null($newname))
        {
            $this->name=$newname;
        }
        return $this->name;
    }
    var $surname = "";
    function surname($newsurname = NULL)
    {
        if(! is_null($newsurname))
        {
            $this->surname=$newsurname;
        }
        return $this->surname;
    }
    var $age = "";
    function age($newage = NULL)
    {
        if(! is_null($newage))
        {
            $this->age=$newage;
        }
        return $this->age;
    }
}

$bob = new person;
$bob->name('Bob');
$bob->surname('Builder');
$bob->age('50');

printf("Hi %s, your surname is %s and you are %s years old", $bob->name, $bob->surname, $bob->age);

Outputs:

Hi Bob, your surname is Builder and you are 50 years old

down

-22

codeslinger at compsalot dot com ¶

19 years ago


Several people have commented about problems with aligning numbers.  I just wanted to add a bit of clarification.

According to the spec all True Type Fonts (especially porpotional spaced fonts) use a fixed width for numeric digits.  All digits have the same width which is equal to the width of "0".

Where things go haywire when trying to align numbers is that the space character does not have the same width as a digit when using a porportional spaced font.

Therefore if you want to line up a column of numbers, you can not use leading spaces to position them unless you use the same quantity of space characters for each row. e.g. your numbers have leading zeros etc.

The simplest solution is to switch to a monospaced font.  Alternativly you can use positioning tags.

Summary: Your numbers will always line up properly regardless of the font used, if you get the starting position to be consistant.

down

-22

kalai_msc29 at rediffmail dot com ¶

17 years ago


//If you want to make many Hidden fields you can use the function 
//You can pass the values as array value,This will help you, when you are going to post many hiddend fields:-
function MakeHidden($ArrValues)
    {
       global $dearvar;
       echo $dearvar; 
       if(is_array($ArrValues)){
             foreach($ArrValues as $key=>$values)
              {
                 echo $MakeHTML = "<input type='hidden' name='$values' value='$values'>";
               }
      }    
      
      
      else {
            echo $MakeHTML = "<input type='hidden' name='$ArrValues' value='$ArrValues'>";
         }
   return $MakeHTML;
}

//example:-

MakeHidden(array("value1","value2","value3"));

//OutPut :-

<input type="hidden" value="value1" name="value1"/>
<input type="hidden" value="value2" name="value2"/>
<input type="hidden" value="value3" name="value3"/>

down

-25

lordfarquaad at notredomaine dot net ¶

20 years ago


In response to chris dot breen at accurate dot com :

This will work, but i didn't try:
<?php 
$format = 'The %2$s contains %1$d monkeys. 
         That is a nice %2$s full of %1$d monkeys.'; 
printf($format, $num, $location); 
?>

Your problem came from the fact that in the string "\$s", the $ is simply escaped by the \, but but you must not do that with single quoted strings. Try to echo your strings to test it, or just go to http://www.php.net/manual/en/language.types.string.php

add a note