概要
number_format_i18n関数は、数値を1000位毎にグループ化して国際化対応にフォーマットするために使用されます。この関数は、数値を適切に表現するためのフォーマットを適用し、地域設定に基づく数値の表示を簡単に行うことができます。number_format_i18nは、特に国や地域によって異なる数値の区切りや小数点の表示方法を考慮する必要がある場合に非常に便利です。
number_format_i18n関数がよく使われるケースは以下の通りです：
- 金額の表示
- 在庫数の表示
- ユーザーによる入力数値のフォーマット
- 投稿の閲覧数やいいね数の表示
- サイト統計の表示
- 商品の価格一覧
- フィードバックやレビューの評価数の表示
- 統計情報やグラフの数値表示
構文
number_format_i18n( $number, $decimals = null );
パラメータ
- $number (float|string) — フォーマットする数値。
- $decimals (int|null) — 小数点以下の桁数。省略した場合、サイトの設定に基づく値が使用されます。
戻り値
指定した数値を国際化対応でフォーマットした文字列。
関連する関数
バージョン
この関数は、WordPress 2.0.0以降で使用可能です。
コアファイルのパス
wp-includes/functions.php
サンプルコード
サンプルコード1: 基本的な数値フォーマット
$value = 1234567.89;
$formatted_value = number_format_i18n($value);
echo $formatted_value; // 結果: "1,234,567.89" (ロケールに依存)
このサンプルコードでは、数値を基本的な形式でフォーマットします。
サンプルコード2: 小数点以下の桁数指定
$value = 1234.5678;
$formatted_value = number_format_i18n($value, 2);
echo $formatted_value; // 結果: "1,234.57" (小数点以下2桁)
このサンプルコードでは、小数点以下の桁数を指定して数値をフォーマットします。
サンプルコード3: 整数のフォーマット
$value = 2500;
$formatted_value = number_format_i18n($value);
echo $formatted_value; // 結果: "2,500"
このサンプルコードでは、整数をフォーマットします。
サンプルコード4: 負の数のフォーマット
$value = -9876.5432;
$formatted_value = number_format_i18n($value, 2);
echo $formatted_value; // 結果: "-9,876.54"
このサンプルコードでは、負の数値をフォーマットしています。
サンプルコード5: 国際化対応のテスト
$value = 1234567.89;
// ロケールが"fr_FR"（フランス）でのフォーマット
setlocale(LC_MONETARY, 'fr_FR');
$formatted_value = number_format_i18n($value);
echo $formatted_value; // 結果: "1 234 567,89" （フランスの形式）
このサンプルコードでは、ロケールを設定し、国際化に基づいて数値をフォーマットしています。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
この関数は特定のバージョンで非推奨や削除されていません。