acf_format_filesize() の説明と使用例

WordPressのacf_format_filesize()関数は、ファイルサイズを人間が読みやすい形式にフォーマットするために使用されます。この関数は、Advanced Custom Fields (ACF) プラグインの一部として提供されています。

構文

acf_format_filesize( int $bytes, int $decimals = 0 );

引数の説明:

$bytes(int) — フォーマットするファイルサイズをバイト単位で指定します。
$decimals(int) — 小数点以下の桁数を指定します。デフォルトは0です。

例1: 基本的な使用法

ファイルサイズをバイト単位で指定し、人間が読みやすい形式に変換します。

<?php echo acf_format_filesize(1024); ?>

例2: 小数点以下の桁数を指定

ファイルサイズをフォーマットし、小数点以下2桁まで表示します。

<?php echo acf_format_filesize(2048, 2); ?>

例3: 大きなファイルサイズのフォーマット

大きなファイルサイズをフォーマットします。

<?php echo acf_format_filesize(1048576); ?>

例4: 動的なファイルサイズのフォーマット

動的に取得したファイルサイズをフォーマットします。

<?php $file_size = filesize('path/to/file.jpg'); echo acf_format_filesize($file_size); ?>

例5: カスタムフィールドの値を使用

ACFのカスタムフィールドから取得したファイルサイズをフォーマットします。

<?php $file_size = get_field('file_size'); echo acf_format_filesize($file_size); ?>

例6: メタデータからのファイルサイズ

投稿のメタデータからファイルサイズを取得し、フォーマットします。

<?php $file_size = get_post_meta(get_the_ID(), 'file_size', true); echo acf_format_filesize($file_size); ?>

例7: アップロードされたファイルのサイズをフォーマット

アップロードされたファイルのサイズをフォーマットします。

<?php $file = $_FILES['file']; echo acf_format_filesize($file['size']); ?>

例8: フィルターフックとの併用

フォーマットされたファイルサイズをフィルターフックで変更します。

<?php add_filter('acf/format_filesize', function($formatted_size) { return str_replace('KB', 'キロバイト', $formatted_size); }); echo acf_format_filesize(1024); ?>

注意点

acf_format_filesize()関数は、ACFプラグインが有効になっている場合にのみ使用できます。
ファイルサイズが非常に大きい場合、適切な単位（GB、TBなど）に自動的に変換されます。
小数点以下の桁数を指定する場合、フォーマット結果が正確でないことがあるため、注意が必要です。