printf

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

    printf — Output a formatted string

    Опис

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

    Produces output according to format.

    Параметри

    format

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

    Специфікатор перетворення відповідає прототипу: %[argnum$][flags][width][.precision]specifier.

    Номер параметра

    Ціле число, слідом за ним — знак долара $. Вказує порядковий номер параметра для перетворення.

    Прапорці
    Позначення Опис
    - Вирівнює по лівому краю в межах заданої ширини. Праве вирівнювання виконується автоматично.
    + Дописує до додатнього числа знак +. Знак мінуса до від'ємного числа дописується автоматично.
    (пропуск) Доповнює результат пропусками. Також виконується автоматично.
    0 Доповнює число нулями ліворуч. Разом зі специфікатором s доповнює число нулями також праворуч.
    ' (символ) Доповнює рядок символом (символ).

    Ширина

    Може бути цілим числом, що вказує найменшу кількість символів в значенні після перетворення, або знак *. Якщо використано знак *, то ширина вказується як додаткове ціле число, що передує значенню, відформатованому специфікатором.

    Точність

    Крапка ., за якою (необов'язково) слідує ціле число чи знак *, значення якого залежить від специфікатора:

    • Для специфікаторів 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, якщо точність дорівнює нулю. Тоді, якщо перетворення в стилі "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

    Значення, що повертаються

    Returns the length of the outputted string.

    Помилки/виключення

    Починаючи з PHP 8.0.0, якщо не задано жодного параметра, то викидається ValueError. Раніше виводилось повідомлення E_WARNING.

    Починаючи з PHP 8.0.0, якщо значення [width] менше за нуль або більше за PHP_INT_MAX, то викидається ValueError. Раніше виводилось повідомлення E_WARNING.

    Починаючи з PHP 8.0.0, якщо значення [precision] менше за нуль або більше за PHP_INT_MAX, то викидається ValueError. Раніше виводилось повідомлення E_WARNING.

    Починаючи з PHP 8.0.0, якщо якщо не задано обов'язкові параметри, то викидається ArgumentCountError. Раніше функція повертала false, а також виводилося повідомлення 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(): various examples

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

    // notice the double %%, this prints a literal '%' character
    printf("%%b = '%b'\n", $n); // binary representation
    printf("%%c = '%c'\n", $c); // print the ascii character, same as chr() function
    printf("%%d = '%d'\n", $n); // standard integer representation
    printf("%%e = '%e'\n", $n); // scientific notation
    printf("%%u = '%u'\n", $n); // unsigned integer representation of a positive integer
    printf("%%u = '%u'\n", $u); // unsigned integer representation of a negative integer
    printf("%%f = '%f'\n", $n); // floating point representation
    printf("%%o = '%o'\n", $n); // octal representation
    printf("%%s = '%s'\n", $n); // string representation
    printf("%%x = '%x'\n", $n); // hexadecimal representation (lower-case)
    printf("%%X = '%X'\n", $n); // hexadecimal representation (upper-case)

    printf("%%+d = '%+d'\n", $n); // sign specifier on a positive integer
    printf("%%+d = '%+d'\n", $u); // sign specifier on a negative integer
    ?>

    Поданий вище приклад виведе:

    %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(): string specifiers

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

    printf("[%s]\n", $s); // standard string output
    printf("[%10s]\n", $s); // right-justification with spaces
    printf("[%-10s]\n", $s); // left-justification with spaces
    printf("[%010s]\n", $s); // zero-padding works on strings too
    printf("[%'#10s]\n", $s); // use the custom padding character '#'
    printf("[%'#*s]\n", 10, $s); // Provide the padding width as an additional argument
    printf("[%10.9s]\n", $t); // right-justification but with a cutoff of 8 characters
    printf("[%-10.9s]\n", $t); // left-justification but with a cutoff of 8 characters
    ?>

    Поданий вище приклад виведе:

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

    Прогляньте також

    • print - Output a string
    • sprintf() - Return a formatted string
    • fprintf() - Write a formatted string to a stream
    • vprintf() - Output a formatted string
    • vsprintf() - Return a formatted string
    • vfprintf() - Write a formatted string to a stream
    • sscanf() - Parses input from a string according to a format
    • fscanf() - Parses input from a file according to a format
    • number_format() - Format a number with grouped thousands
    • date() - Format a Unix timestamp
    • flush() - Flush system output buffer

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 4 notes

    up
    19
    dhosek at excite dot com
    25 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.
    up
    8
    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
    up
    1
    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()
    up
    -1
    simon dot patrick at cantab dot net
    6 months ago
    A few things to note about printf:
    1. The definition of specifier g (or G) is often wrongly stated as being "use e or f (or E or f), whichever results in the shorter string". The correct rule is given in the documentation and it does not always give this result.
    2. For g/G/h/H, trailing zeros after the decimal point are removed (but not a zero just after the decimal point, in the e/E style).
    3. g/G are locale-aware whether the e/E or f style is produced.
    4. For b/o/x/X/u (that is, all integer styles except d) the result shown for negative values is the twos complement form of the number, 2**32 + v, where v is the (negative) value.
    ＋add a note
    To Top