【PHP8.x】printf()関数の使い方

Copy
1<?php
2
3/**
4 * printf 関数の基本的な使い方を示すサンプルコードです。
5 * printf は、指定されたフォーマット文字列に従って値を出力します。
6 * 戻り値は、出力された文字数です。
7 */
8
9// サンプルデータを用意します。
10$productName = "ノートPC";
11$productId = 1001;
12$price = 999.99;
13$stock = 50;
14
15echo "--- 商品情報の出力例 ---\n\n";
16
17// 1. 基本的な文字列と整数のフォーマット
18// %s: 文字列、%d: 整数
19// 出力された文字数も確認できます。
20echo "例1: 商品名とID\n";
21$charsPrinted1 = printf("商品名: %s, 商品ID: %d\n", $productName, $productId);
22echo " -> 出力された文字数: " . $charsPrinted1 . "\n\n";
23
24// 2. 浮動小数点数のフォーマットと桁数指定
25// %.2f: 小数点以下2桁まで表示される浮動小数点数
26echo "例2: 価格の表示\n";
27$charsPrinted2 = printf("価格: $%.2f\n", $price);
28echo " -> 出力された文字数: " . $charsPrinted2 . "\n\n";
29
30// 3. より詳細なフォーマット指定
31// %-15s: 左寄せで幅15文字の文字列
32// %05d: 0埋めして幅5桁の整数
33echo "例3: 在庫情報の詳細表示\n";
34$charsPrinted3 = printf("カテゴリ: %-15s | 商品ID: %05d | 在庫数: %d個\n", "電子機器", $productId, $stock);
35echo " -> 出力された文字数: " . $charsPrinted3 . "\n\n";
36
37// 4. 複数回printfを使用する例
38echo "例4: 複数のprintf文\n";
39printf("本日の日付: %s\n", date("Y-m-d"));
40printf("現在の時刻: %s\n", date("H:i:s"));
41
42?>

PHPのprintf関数は、指定されたフォーマット（書式）に従ってデータを出力するための機能です。主に、変数や値を整形して画面に表示したり、ファイルに書き込んだりする際に利用されます。

この関数は、最初の引数に文字列でフォーマットを指定します。このフォーマット文字列には、出力したいデータの種類や表示形式を示す「プレースホルダー」を含めることができます。例えば、%sは文字列、%dは整数、%.2fは小数点以下2桁の浮動小数点数を出力することを示します。2番目以降の引数には、これらのプレースホルダーに対応する値が順番に渡されます。

printf関数は、実際に出力された文字数を整数で返します。これにより、出力処理が成功したか、どれくらいのデータが書き出されたかを確認することができます。

サンプルコードでは、様々なプレースホルダーの使い方を紹介しています。%sや%dで商品名やIDをシンプルに出力する例や、%.2fで価格を小数点以下2桁に丸めて表示する例があります。さらに、%-15sのように文字列を左寄せで特定の幅に揃えたり、%05dのように整数をゼロで埋めて桁数を揃えたりするなど、より詳細なフォーマット指定も可能です。これにより、整然とした見やすい情報を出力することができます。

Copy
1<?php
2
3/**
4 * printf と sprintf の違いを実演する関数。
5 *
6 * printf は書式設定された文字列を直接出力します。
7 * sprintf は書式設定された文字列を文字列として返します。
8 *
9 * システムエンジニアを目指す初心者にも理解しやすいように、具体的な使用例を通して両者の違いを説明します。
10 */
11function demonstratePrintfAndSprintfDifference(): void
12{
13    // 書式設定に使用するデータ
14    $productName = "スマートウォッチ";
15    $price = 299.99;
16    $stock = 15;
17
18    echo "--- printf の使用例 (直接出力) ---\n";
19    // printf は書式設定された文字列を直接標準出力に出力します。
20    // 戻り値は出力されたバイト数です。
21    $bytesPrinted = printf(
22        "製品名: %s, 価格: $%.2f, 在庫数: %d個\n",
23        $productName,
24        $price,
25        $stock
26    );
27    echo "printf で出力されたバイト数: " . $bytesPrinted . "バイト\n\n";
28
29    echo "--- sprintf の使用例 (文字列として取得) ---\n";
30    // sprintf は書式設定された文字列を生成し、それを戻り値として返します。
31    // この文字列を変数に格納し、後でファイルに書き込んだり、別の処理に使用したりできます。
32    $formattedString = sprintf(
33        "製品名: %s, 価格: $%.2f, 在庫数: %d個", // printf と同じフォーマット文字列を使用
34        $productName,
35        $price,
36        $stock
37    );
38    echo "sprintf で生成された文字列: " . $formattedString . "\n";
39    echo "（この文字列は変数に格納されており、必要に応じて後で echo や他の処理で利用できます。）\n";
40}
41
42// 関数を実行して、printf と sprintf の動作を確認します。
43demonstratePrintfAndSprintfDifference();
44
45?>

PHP 8のprintf関数は、指定された書式（フォーマット）に従ってデータを整形し、その結果を直接標準出力に出力する機能を提供します。第一引数$formatには、整形方法を指定する文字列（例: %sは文字列、%.2fは小数点以下2桁の浮動小数点数、%dは整数）を渡し、それに続く...$values引数には、整形する値を複数渡します。この関数は、実際に出力されたバイト数を整数（int）として返します。

本サンプルコードでは、printfとsprintfの違いを明確に示しています。printfは整形された文字列をその場で画面に出力する点が特徴です。例えば、製品名や価格、在庫数を整形してすぐに表示する際に便利で、実行後に出力されたバイト数が戻り値として取得できます。

一方、sprintfはprintfと同じ書式指定で文字列を整形しますが、結果を直接出力するのではなく、整形された文字列を戻り値として返します。このため、サンプルコードのように$formattedString変数に格納し、後からファイルに書き込んだり、別の処理で利用したりするなど、柔軟な使い方が可能です。データの表示方法を制御したい場合や、文字列を加工して使いたい場合にsprintfが適しています。

Copy
1<?php
2
3/**
4 * printf 関数の使用例
5 *
6 * 指定されたフォーマットに従って文字列を出力します。
7 */
8
9// 文字列と数値をフォーマットして出力
10$name = "Taro";
11$age = 30;
12$formattedString = sprintf("My name is %s, and I am %d years old.", $name, $age);
13echo $formattedString . PHP_EOL; // My name is Taro, and I am 30 years old.
14
15// 浮動小数点数をフォーマットして出力
16$price = 19.99;
17printf("The price is %.2f dollars.\n", $price); // The price is 19.99 dollars.
18
19// 複数の値をフォーマットして出力
20$quantity = 5;
21$item = "apple";
22printf("I have %d %ss.\n", $quantity, $item); // I have 5 apples.
23
24// 16進数で出力
25$number = 255;
26printf("The hexadecimal value is %X.\n", $number); // The hexadecimal value is FF.
27
28// パーセント記号を出力
29$percentage = 85;
30printf("The success rate is %d%%.\n", $percentage); // The success rate is 85%.
31?>

printf関数は、PHPで指定されたフォーマットに基づいて文字列を出力するために使用されます。第一引数$formatは、出力形式を指定する文字列です。この文字列には、プレースホルダーと呼ばれる特殊な記号が含まれており、...$valuesで指定された値が対応するプレースホルダーの位置に埋め込まれます。

例えば、%sは文字列、%dは整数、%fは浮動小数点数をそれぞれ表します。%.2fのように小数点以下の桁数を指定することも可能です。%Xは数値を16進数で出力します。パーセント記号を出力したい場合は、%%と記述します。

サンプルコードでは、sprintf関数と組み合わせて、フォーマットされた文字列を変数に格納してからechoで出力する方法も示されています。sprintf関数はprintf関数と似ていますが、出力を直接行うのではなく、フォーマットされた文字列を返します。printf関数は出力された文字列の長さを整数値で返します。PHP_EOLは、改行文字を表す定義済みの定数で、プラットフォームに依存しない改行を行う際に便利です。printf関数を使うことで、変数の値を埋め込んだり、数値の表示形式を整えたりして、見やすく、より分かりやすい出力を実現できます。

Copy
1<?php
2
3/**
4 * printf 関数を使った改行付きの出力例
5 */
6function printfWithNewline(): void
7{
8    $name = "太郎";
9    $age = 30;
10
11    // 名前と年齢を改行付きで出力
12    $result = printf("名前: %s\n年齢: %d\n", $name, $age);
13
14    // printf は出力した文字数を返す
15    echo "出力文字数: " . $result . "\n";
16}
17
18// 関数の実行
19printfWithNewline();
20
21?>

PHPのprintf関数は、指定されたフォーマット文字列に従って引数を整形し、結果を出力する関数です。この関数を使うことで、変数の値を埋め込んだ文字列を簡単に生成し、画面やファイルに出力できます。

printf関数の第一引数には、フォーマット文字列を指定します。フォーマット文字列には、プレースホルダーと呼ばれる特殊な記号が含まれており、%s（文字列）、%d（整数）などの種類があります。これらのプレースホルダーは、続く引数の値で順番に置き換えられます。例えば、printf("名前: %s 年齢: %d", $name, $age)というコードは、$nameと$ageの値をフォーマット文字列に埋め込んで出力します。

サンプルコードでは、printfWithNewline関数内でprintf関数を使って、名前と年齢を改行付きで出力しています。\nは改行文字を表し、出力結果を読みやすくするために使用されています。

printf関数の戻り値は、出力した文字数です。サンプルコードでは、$result = printf("名前: %s\n年齢: %d\n", $name, $age)のように、戻り値を変数に格納し、その後echo "出力文字数: " . $result . "\n";で出力しています。これによって、printf関数が実際に何文字出力したかを確認できます。printf関数は、複雑な文字列のフォーマットや、数値の書式設定など、多様な出力形式に対応できる便利な関数です。