size_format() の使い方｜説明・引数・注意点

説明

基本構文

size_format( int|string $bytes, int $decimals = 0 ): string|false

引数

• $bytes：バイト数
• $decimals：小数点以下の桁数

戻り値

変換後の文字列。

使い方（サンプル）

echo esc_html( size_format( 1572864, 1 ) );

注意点

• 不正な値は false を返します。

実務での使いどころ

• ファイルサイズ（バイト数）を、「1.5 MB」のような、読みやすい形式で、表示するとき。

よくあるミスと対処

• $decimals の既定は、0。小数を、表示したいときは、指定する。
• 単位つきの文字列（"2MB"）を、渡している。渡すのは、バイト数の数値。
• 負の数や、数値でない値では、false が返る。

NG例

echo size_format( '2MB' ); // 数値ではなく、単位付きの文字列

OK例

echo esc_html( size_format( filesize( $path ), 1 ) );

使い分け早見表

関連項目

number_format_i18n()

公式リファレンス：size_format() | Function | WordPress Developer Resources