sprintf( string $format[, mixed $args[, mixed $… ]] )

投稿日: 2012年10月23日 作成者: alphasis

sprintf( string $format[, mixed $args[, mixed $... ]] )は、フォーマット「$format」に基づき生成した文字列を返す組み込み関数。

定義

文字列型 sprintf( 文字列型 $format[, 多様な型 $args[, 多様な型 $...]] );

パラメータ

文字列型 $format

フォーマット。

多様な型 $args

オプション。

フォーマットしたいデータ。

多様な型 $…

オプション。

フォーマットしたいデータは、カンマ,で区切り、複数指定できる。

フォーマット

% 位置指定子 符号指定子 パディング指定子 アラインメント指定子 表示幅指定子 精度指定子 型指定子

%の後に、空白は入れずに、指定子を続けて記述する。

位置指定子

オプション。

フォーマットしたいデータが複数あり、順番を入れ替えたい場合に使う。

n番目のデータを、n$とする。１番目のデータは、1$。5番目のデータは、5$となる。

変換指定子

下記の変換指定子を、１つ以上続けて記述する。

符号指定子

オプション。

何も指定しないと、負の数にだけ、符号を付ける。正の数には、プラス符号「+」を付けない。負の数には、マイナス符号「-」を付ける。

+を指定すると、正の数にも、符号を付ける。正の数には、プラス符号「+」を付け、負の数には、マイナス符号「-」を付ける。

パディング指定子

オプション。

「表示幅指定子」に指定した長さになるまで、どんな文字で埋めるかを指定する。

  • 半角空白: 半角空白で埋める。初期設定値。
  • 0: 0で埋める。ゼロパディング。
  • '任意の一文字: 単一引用符'に続く「任意の一文字」で埋める。
アラインメント指定子

オプション。

左寄せか、右寄せかを指定する。

初期設定値は、右寄せ。

-を指定すると、左寄せ。

表示幅指定子

オプション。

最低何桁にするかを、数字で指定。

精度指定子

オプション。

数字で指定。

浮動小数点数の場合、小数点以下の小数部を、「精度指定子」に指定した数の位まで表示する。

文字列の場合、「精度指定子」に指定した文字数を超える文字を切り捨てる。

型指定子

オプション。

引数の「多様な型 $args」や「多様な型 $…」を、何のデータ型で扱うかを指定する。

  • %: パーセント記号。
  • b: 引数を整数として扱い、２進数に変換。
  • c: 引数を整数として扱い、ASCII値の文字として表現。
  • d: 引数を整数として扱い、１０進数に変換。
  • e: 引数を科学記法として扱う。小文字を使う。
  • E: 引数を科学記法として扱う。大文字を使う。
  • u: 引数を整数として扱い、符号がない１０進数に変換。
  • f: 引数をdoubleとして扱い、浮動小数点数として表現。
  • F: 引数をfloatとして扱い、浮動小数点数として表現。
  • g: %e および %f の短縮形。
  • G: %E および %f の短縮形。
  • o: 引数を整数として扱い、 ８進数に変換。
  • s: 引数を文字列として扱う。
  • x: 引数を整数として扱い、１６進数（小文字）に変換。
  • X: 引数を整数として扱い、１６進数（大文字）に変換。

構文

フォーマット済み文字列を返す（１）

sprintf( フォーマット, フォーマットしたいデータ );

「フォーマット」に基づき生成した文字列を返す。

フォーマット済み文字列を返す（２）

sprintf( フォーマット, フォーマットしたいデータ１, フォーマットしたいデータ２, フォーマットしたいデータ３ );

「フォーマット」に基づき生成した文字列を返す。

戻り値

フォーマットに基づき生成した文字列。

サンプル

整数を、様々な変換指定子でフォーマット

<?php
$var = 123;
echo sprintf( "<p>%%d: [%d]</p>", $var );
echo sprintf( "<p>%%+d: [%+d]</p>", $var );
echo sprintf( "<p>%%5d: [%5d]</p>", $var );
echo sprintf( "<p>%%05d: [%05d]</p>", $var );
echo sprintf( "<p>%%'#5d: [%'#5d]</p>", $var );
echo sprintf( "<p>%%'#-5d: [%'#-5d]</p>", $var );
echo sprintf( "<p>%%.2s: [%.2s]</p>", $var );
?>

↓↓↓出力結果↓↓↓

%d: [123]
%+d: [+123]
%5d: [  123]
%05d: [00123]
%'#5d: [##123]
%'#-5d: [123##]
%.2s: [12]

小数を、様々な変換指定子でフォーマット

<?php
$var = 1.23456789;
echo sprintf( "<p>%%f: %f</p>", $var );
echo sprintf( "<p>%%+f: %+f</p>", $var );
echo sprintf( "<p>%%0.10f: %0.10f</p>", $var );
echo sprintf( "<p>%%.3f: %.3f</p>", $var );
echo sprintf( "<p>%%.3s: %.3s</p>", $var );
?>

↓↓↓出力結果↓↓↓

%f: 1.234568
%+f: +1.234568
%0.10f: 1.2345678900
%.3f: 1.235
%.3s: 1.2

文字列を、様々な変換指定子でフォーマット

<?php
$var = "sample";
echo sprintf( "<p>%%s: [%s]</p>", $var );
echo sprintf( "<p>%%+s: [%+s]</p>", $var );
echo sprintf( "<p>%%10s: [%10s]</p>", $var );
echo sprintf( "<p>%%010s: [%010s]</p>", $var );
echo sprintf( "<p>%%'#10s: [%'#10s]</p>", $var );
echo sprintf( "<p>%%'#-10s: [%'#-10s]</p>", $var );
echo sprintf( "<p>%%.3s: [%.3s]</p>", $var );
?>

↓↓↓出力結果↓↓↓

%s: [sample]
%+s: [sample]
%10s: [    sample]
%010s: [0000sample]
%'#10s: [####sample]
%'#-10s: [sample####]
%.3s: [sam]

日付を、フォーマット

<?php
$varYear = 2012;
$varMonth = 7;
$varDay = 3;
$format = '%04d-%02d-%02d';
echo sprintf( "<p>年月日（YYYY-MM-DD）: $format</p>", $varYear, $varMonth, $varDay );
$format = '%2$02d-%3$02d-%1$04d';
echo sprintf( "<p>月日年（MM-DD-YYYY）: $format</p>", $varYear, $varMonth, $varDay );
$format = '%3$02d-%2$02d-%1$04d';
echo sprintf( "<p>日月年（DD-MM-YYYY）: $format</p>", $varYear, $varMonth, $varDay );
$format = '%04d年%02d月%02d日';
echo sprintf( "<p>年月日（YYYY年MM月DD日）: $format</p>", $varYear, $varMonth, $varDay );
?>

↓↓↓出力結果↓↓↓

年月日（YYYY-MM-DD）: 2012-07-03
月日年（MM-DD-YYYY）: 07-03-2012
日月年（DD-MM-YYYY）: 03-07-2012
年月日（YYYY年MM月DD日）: 2012年07月03日

複数の整数を、フォーマット

<?php
$varA = 1;
$varB = 2;
$varC = 3;
$varD = $varA+$varB+$varC;
$format = '%d＋%d＋%d＝%d';
echo sprintf( "<p>$format</p>", $varA, $varB, $varC, $varD );
$format = '%1$d＋%2$d＋%3$d＝%4$d';
echo sprintf( "<p>$format</p>", $varA, $varB, $varC, $varD );
$format = '%3$d＋%2$d＋%1$d＝%4$d';
echo sprintf( "<p>$format</p>", $varA, $varB, $varC, $varD );
?>

↓↓↓出力結果↓↓↓

1＋2＋3＝6
1＋2＋3＝6
3＋2＋1＝6

整数を、様々な型指定子でフォーマット

<?php
$var = 123;
echo sprintf( "<p>%%b: %b</p>", $var );
echo sprintf( "<p>%%c: %c</p>", $var );
echo sprintf( "<p>%%d: %d</p>", $var );
echo sprintf( "<p>%%e: %e</p>", $var );
echo sprintf( "<p>%%E: %E</p>", $var );
echo sprintf( "<p>%%u: %u</p>", $var );
echo sprintf( "<p>%%f: %f</p>", $var );
echo sprintf( "<p>%%F: %F</p>", $var );
echo sprintf( "<p>%%g: %g</p>", $var );
echo sprintf( "<p>%%G: %G</p>", $var );
echo sprintf( "<p>%%o: %o</p>", $var );
echo sprintf( "<p>%%s: %s</p>", $var );
echo sprintf( "<p>%%x: %x</p>", $var );
echo sprintf( "<p>%%X: %X</p>", $var );
?>

↓↓↓出力結果↓↓↓

%b: 1111011
%c: {
%d: 123
%e: 1.230000e+2
%E: 1.230000E+2
%u: 123
%f: 123.000000
%F: 123.000000
%g: 123
%G: 123
%o: 173
%s: 123
%x: 7b
%X: 7B

スポンサード リンク

カテゴリー: PHP, フォーマット, 文字列, 組み込み関数 タグ: パーマリンク