Description

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

Affiche une chaîne de caractères formatée.

Liste de paramètres

format

La chaîne de format est composé de zéro ou plusieurs directives : des caractères ordinaires (à l'exception de %) qui sont copiés directement dans le résultat et des spécifications de conversion, chacun ayant pour résultat de récupérer ses propres paramètre.

Une spécification de conversion qui suit ce prototype : %[argnum$][flags][width][.precision]specifier.

Argnum

Un entier suivit d'un signe dollar $, pour spécifier quel numéro d'argument à traiter dans la conversion.

Drapeaux

Drapeau Description

- Justifie le texte à gauche donnée la largeur du champ ; Justification à droite est le comportement par défaut.

+ Préfixe les nombres positives avec un signe plus + ; Par défaut seul les nombres négatifs sont préfixés avec un signe négatif.

(espace) Complète le résultat avec des espaces. Ceci est par défaut.

0 Complète uniquement les nombres à gauches avec des zéros. Avec le spécificateur s ceci peut aussi compléter à droite avec des zéros.

'(char) Complète le résultat avec le caractère (char).

Drapeau	Description
`-`	Justifie le texte à gauche donnée la largeur du champ ; Justification à droite est le comportement par défaut.
`+`	Préfixe les nombres positives avec un signe plus `+` ; Par défaut seul les nombres négatifs sont préfixés avec un signe négatif.
(espace)	Complète le résultat avec des espaces. Ceci est par défaut.
`0`	Complète uniquement les nombres à gauches avec des zéros. Avec le spécificateur `s` ceci peut aussi compléter à droite avec des zéros.
`'`(char)	Complète le résultat avec le caractère (char).

Largeur

Soit un entier indiquant le nombre de caractères (minimum) que cette conversion doit produire, soit *. Si * est utilisé, alors la largeur est fournie en tant que valeur entière supplémentaire précédant celle formatée par le spécificateur.

Precision

Un point . suivi optionnellement soit d'un entier, soit de *, dont la signification dépend du spécificateur :

Pour les spécificateurs e, E, f et F : ceci est le nombre de chiffres à afficher après la virgule (par défaut, ceci est 6).
Pour les spécificateurs g, G, h et H : ceci est le nombre maximal de chiffres significatifs à afficher. digits to be printed.
Pour le spécificateur s : il agit comme un point de coupure, définissant une limite maximale de caractères de la chaîne.

Note: Si le point est spécifié sans une valeur explicite pour la précision, 0 est assumé. Si * est utilisé, la précision est fournie en tant que valeur entière supplémentaire précédant celle formatée par le spécificateur.

Spécificateurs

Spécificateur Description

% Un caractère de pourcentage littéral. Aucun argument n'est nécessaire.

b L'argument est traité comme un entier et présenté comme un nombre binaire.

c L'argument est traité comme un entier et présenté comme le caractère de code ASCII correspondant.

d L'argument est traité comme un entier et présenté comme un nombre entier décimal (signé).

e L'argument est traité comme une notation scientifique (e.g. 1.2e+2).

E Comme le spécificateur e mais utilise une lettre majuscule (par exemple 1.2E+2).

f L'argument est traité comme un nombre à virgule flottante (type nombre décimal) et présenté comme un nombre à virgule flottante (tenant compte de la locale utilisée).

F L'argument est traité comme un nombre à virgule flottante (type nombre décimal) et présenté comme un nombre à virgule flottante (ne tenant pas compte de la locale utilisée).

g
Format général.

Soit P égal à la précision si différent de 0, 6 si la précision est omit ou 1 si la précision est zéro. Alors, si la conversion avec le style E aurait comme exposant X :

Si P > X ≥ −4, la conversion est avec style f et précision P − (X + 1). Sinon, la conversion est avec le style e et précision P - 1.

G Comme le spécificateur g mais utilise E et f.

h Comme le spécificateur g mais utilise F. Disponible à partir de PHP 8.0.0.

H Comme le spécificateur g mais utilise E et F. Disponible à partir de PHP 8.0.0.

o L'argument est traité comme un entier et présenté comme un nombre octal.

s L'argument est traité et présenté comme une chaîne de caractères.

u L'argument est traité comme un entier et présenté comme un nombre décimal non signé.

x L'argument est traité comme un entier et présenté comme un nombre hexadécimal (les lettres en minuscules).

X L'argument est traité comme un entier et présenté comme un nombre hexadécimal (les lettres en majuscules).

**Spécificateurs**
Spécificateur	Description
`%`	Un caractère de pourcentage littéral. Aucun argument n'est nécessaire.
`b`	L'argument est traité comme un entier et présenté comme un nombre binaire.
`c`	L'argument est traité comme un entier et présenté comme le caractère de code ASCII correspondant.
`d`	L'argument est traité comme un entier et présenté comme un nombre entier décimal (signé).
`e`	L'argument est traité comme une notation scientifique (e.g. `1.2e+2`).
`E`	Comme le spécificateur `e` mais utilise une lettre majuscule (par exemple 1.2E+2).
`f`	L'argument est traité comme un nombre à virgule flottante (type nombre décimal) et présenté comme un nombre à virgule flottante (tenant compte de la locale utilisée).
`F`	L'argument est traité comme un nombre à virgule flottante (type nombre décimal) et présenté comme un nombre à virgule flottante (ne tenant pas compte de la locale utilisée).
`g`	Format général. Soit P égal à la précision si différent de 0, 6 si la précision est omit ou 1 si la précision est zéro. Alors, si la conversion avec le style E aurait comme exposant X : Si P > X ≥ −4, la conversion est avec style f et précision P − (X + 1). Sinon, la conversion est avec le style e et précision P - 1.
`G`	Comme le spécificateur `g` mais utilise `E` et `f`.
`h`	Comme le spécificateur `g` mais utilise `F`. Disponible à partir de PHP 8.0.0.
`H`	Comme le spécificateur `g` mais utilise `E` et `F`. Disponible à partir de PHP 8.0.0.
`o`	L'argument est traité comme un entier et présenté comme un nombre octal.
`s`	L'argument est traité et présenté comme une chaîne de caractères.
`u`	L'argument est traité comme un entier et présenté comme un nombre décimal non signé.
`x`	L'argument est traité comme un entier et présenté comme un nombre hexadécimal (les lettres en minuscules).
`X`	L'argument est traité comme un entier et présenté comme un nombre hexadécimal (les lettres en majuscules).

Avertissement

Le spécificateur de type c ignore l'alignement et la taille.

Avertissement

Le fait de tenter d'utiliser une combinaison d'une chaîne et de spécificateurs avec des jeux de caractères qui nécessitent plus d'un octet par caractères donnera un résultat inattendu.

Les variables seront contraints à un type approprié pour le spécificateur :
Gestion des types

Type Spécificateurs

string s

int d, u, c, o, x, X, b

float e, E, f, F, g, G, h, H

values

**Gestion des types**
Type	Spécificateurs
string	`s`
int	`d`, `u`, `c`, `o`, `x`, `X`, `b`
float	`e`, `E`, `f`, `F`, `g`, `G`, `h`, `H`

Valeurs de retour

Retourne la taille de la chaîne affichée.

Erreurs / Exceptions

À partir de PHP 8.0.0, une ValueError est lancée si le nombre d'arguments est nul. Antérieur à PHP 8.0.0, un E_WARNING était émis à la place.

À partir de PHP 8.0.0, une ValueError est lancée si [width] est inférieur à zéro ou supérieur à PHP_INT_MAX. Antérieur à PHP 8.0.0, un E_WARNING était émis à la place.

À partir de PHP 8.0.0, une ValueError est lancée si [precision] est inférieur à zéro ou supérieur à PHP_INT_MAX. Antérieur à PHP 8.0.0, un E_WARNING était émis à la place.

À partir de PHP 8.0.0, une ArgumentCountError est lancée lorsque moins d'arguments sont donnés que requis. Antérieur à PHP 8.0.0, false était retourné et un E_WARNING était émis à la place.

Historique

Version	Description
8.0.0	Cette fonction ne renvoie plus `false` en cas d'échec.
8.0.0	Lance une ValueError si le nombre d'arguments est zéro ; auparavant, cette fonction émettait un `E_WARNING`.
8.0.0	Lance une ValueError si `[width]` est inférieur à zéro ou supérieur à `PHP_INT_MAX` ; auparavant, cette fonction émettait un `E_WARNING`.
8.0.0	Lance une ValueError si `[precision]` est inférieur à zéro ou supérieur à `PHP_INT_MAX` ; auparavant, cette fonction émettait un `E_WARNING`.
8.0.0	Lance une ArgumentCountError lorsque moins d'arguments sont donnés que requis ; auparavant, cette fonction émettait un `E_WARNING`.

Exemples

Exemple #1 printf() : divers exemples

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

// notez le double %%, cela affiche un caractère '%' littéral
printf("%%b = '%b'\n", $n); // représentation binaire
printf("%%c = '%c'\n", $c); // affiche le caractère ascii, comme la fonction chr()
printf("%%d = '%d'\n", $n); // représentation standard d'un entier
printf("%%e = '%e'\n", $n); // notation scientifique
printf("%%u = '%u'\n", $n); // représentation entière non signée d'un entier positif
printf("%%u = '%u'\n", $u); // représentation entière non signée d'un entier négatif
printf("%%f = '%f'\n", $n); // représentation en virgule flottante
printf("%%o = '%o'\n", $n); // représentation octale
printf("%%s = '%s'\n", $n); // représentation chaîne de caractères
printf("%%x = '%x'\n", $n); // représentation hexadécimale (minuscule)
printf("%%X = '%X'\n", $n); // représentation hexadécimale (majuscule)

printf("%%+d = '%+d'\n", $n); // indication du signe pour un entier positif
printf("%%+d = '%+d'\n", $u); // indication du signe pour un entier négatif
?>

L'exemple ci-dessus va afficher :

%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'

Exemple #2 printf() : spécificateurs chaînes de caractères

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

printf("[%s]\n",        $s); // affichage d'une chaîne standard
printf("[%10s]\n",      $s); // justification à droite avec des espaces
printf("[%-10s]\n",     $s); // justification à gauche avec des espaces
printf("[%010s]\n",     $s); // l'espacement nul fonctionne aussi sur les chaînes
printf("[%'#10s]\n",    $s); // utilisation du caractère personnalisé de séparation '#'
printf("[%'#*s]\n", 10, $s); // Fournir la largeur de la justification comme argument supplémentaire
printf("[%10.9s]\n",    $t); // justification à droite mais avec une coupure à 9 caractères
printf("[%-10.9s]\n",   $t); // justification à gauche mais avec une coupure à 9 caractères
?>

L'exemple ci-dessus va afficher :

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

Voir aussi

print - Affiche une chaîne de caractères
sprintf() - Retourne une chaîne formatée
fprintf() - Écrit une chaîne formatée dans un flux
vprintf() - Affiche une chaîne formatée
vsprintf() - Retourne une chaîne formatée
vfprintf() - Écrit une chaîne formatée dans un flux
sscanf() - Analyse une chaîne à l'aide d'un format
fscanf() - Analyse un fichier en fonction d'un format
number_format() - Formate un nombre pour l'affichage
date() - Formate un horodatage Unix
flush() - Vide les tampons de sortie du système