PHP String printf() Function

---

---

The PHP String printf() function is a useful tool for formatting and displaying text in a certain way. It allows us to generate formatted strings that include placeholders for variable values.

This function is very useful for precise control over the look of text, such as aligning columns, defining decimal accuracy, or adding leading zeros.

Format Specifiers

Here are the format specifiers you can use for this function −

• %s: String

• %d or %i: Integer

• %f: Floating-point number

• %c: Character

• %b: Binary

• %o: Octal

• %x or %X: Hexadecimal

• %e or %E: Scientific notation

Syntax

Below is the syntax of the PHP String printf() function −

int printf ( string $format, $arg1, $arg2, $arg++ )

Parameters

Here are the parameters of the printf() function −

• $format − (Required) Defines the string and how to format the variables within it.

• $arg1 − (Required) It is the argument to be inserted at the first %-sign.

• $arg2 − (Optional) It is the argument to be inserted at the second %-sign.

• $arg++ − (Optional) It is the argument to be inserted at the third,fourth, etc. %s sign.

Return Value

The printf() function returns the length of the outputted string.

Errors/Exceptions

Here are the list of errors and exceptions possible for printf() function −

• If no arguments are given, a ValueError is thrown. In older versions (before PHP 8.0.0), it showed a warning (E_WARNING).

• If the width is less than zero or larger than PHP_INT_MAX, a ValueError is thrown. Before PHP 8.0.0, it only gave a warning (E_WARNING).

• If the precision is less than zero or larger than PHP_INT_MAX, a ValueError is thrown. In earlier versions, it showed a warning (E_WARNING).

• If fewer arguments are passed than required, an ArgumentCountError is thrown. Before PHP 8.0.0, it returned false and showed a warning (E_WARNING).

PHP Version

First introduced in core PHP 4, the printf() function continues to function easily in PHP 5, PHP 7, and PHP 8.

Example 1

Here is the basic example to show the usage of the PHP String printf() function.

<?php
   printf("Tutorials point simply easy learning");
?>

Output

This will produce the below outcome −

Tutorials point simply easy learning

Example 2

Here we will show you how the printf() function is used to format and output a string.

<?php
   // Simple string formatting
   $name = "Siya";
   printf("Hello, %s!", $name);
?>

Output

Here is the outcome of the following code −

Hello, Siya!

Example 3

In the below PHP code we will try to use the printf() function and format numbers like integers and floating-point numbers.

<?php
   // Formatting integers and floating-point numbers
   $quantity = 5;
   $price = 12.99;
   printf("You bought %d items for $%.2f.", $quantity, $price);
?> 

Output

This will generate the below output −

You bought 5 items for $12.99.

Example 4

This program demonstrate the use of printf() function to pad and align text or numbers for consistent formatting.

<?php
   // Padding and alignment
   $left = "Apple";
   $right = 150;
   printf("|%-10s|%10d|\n", $left, $right);
?> 

Output

This will create the below output −

|Apple     |       150|

Example 5

In the following example, we are using the printf() function to combine multiple types of placeholders in a formatted output.

<?php
   // Combining placeholders
   $product = "Laptop";
   $price = 25000;
   $discount = 10;
   printf("Product: %-10s | Price: Rs.%.2f | Discount: %d%%\n", $product, $price, $discount);
?> 

Output

Following is the output of the above code −

Product: Laptop     | Price: Rs.25000.00 | Discount: 10%