number_format_i18n() の使い方|説明・引数・注意点

説明

number_format_i18n() は、数値を、サイトの言語に合わせた桁区切りで書式化する関数です。

基本構文

number_format_i18n( float $number, int $decimals = 0 ): string

引数

  • $number:数値
  • $decimals:小数点以下の桁数

戻り値

書式化した文字列。

使い方(サンプル)

echo esc_html( number_format_i18n( 1234567 ) );

注意点

  • 日本語では「1,234,567」のようにカンマ区切りになります。

実務での使いどころ

  • 数値を、ロケールに合わせた、区切り(1,234)で、表示するとき。
  • 小数の桁数を、指定して、表示するとき。

よくあるミスと対処

  • 戻り値は文字列。計算には、使えない。
  • 桁数($decimals)を、指定していない。既定は、0(小数なし)。
  • HTMLに、そのまま出力している。エスケープを通す。

NG例

echo number_format_i18n( 3.14159 ); // 3 と表示される(小数が丸められる)

OK例

echo esc_html( number_format_i18n( 3.14159, 2 ) ); // 3.14

使い分け早見表

関数 特徴
number_format_i18n() ロケールに合わせて、数値を整形する
size_format() バイト数を、「1 MB」のような形式にする
number_format() PHPの関数(ロケールに合わせない)

関連項目

size_format()

公式リファレンス:number_format_i18n() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました