clean_dirsize_cache()
は、指定されたマルチサイトのサイト(ブログ)における「アップロードディレクトリのサイズキャッシュ」を削除する WordPress 関数です。
マルチサイト環境では、ディスク容量制限を適用できるため、各サイトのアップロードサイズをキャッシュして処理の高速化を図っています。この関数はそのキャッシュを明示的にクリアしたいときに使用されます。
基本構文
clean_dirsize_cache( $blog_id );
$blog_id
に指定されたサイトのupload
ディレクトリサイズのキャッシュを削除します。- 実際のディレクトリサイズは
recurse_dirsize()
により再計算されます。
引き数と戻り値
引き数 | 型 | 説明 |
---|---|---|
$blog_id | int | キャッシュを削除する対象のサイト(ブログ)ID |
戻り値 | 型 | 説明 |
---|---|---|
なし(void ) | ― | 副作用的に動作する。返り値はなし。 |
使用例
タグを使った使用例
$blog_id = get_current_blog_id(); // 現在のサイトIDを取得
clean_dirsize_cache( $blog_id );
このコードは、現在のサイトに保存されたアップロードファイルのサイズキャッシュを削除します。キャッシュが削除されると、次回ディスクサイズ確認時に再計算が実行されます。
注意点
- マルチサイトでのみ有効
-
この関数はマルチサイト機能が有効でない環境では無意味です。
- 頻繁な使用は避ける
-
キャッシュ削除によりディレクトリサイズ再計算が走るため、大量のファイルがある環境ではパフォーマンスに影響します。
- 手動アップロード後に使用
-
FTPなどでファイルを直接アップロードした場合、キャッシュに反映されないためこの関数で明示的に削除する必要があります。
よく一緒に使われる関数
get_space_used()
clean_dirsize_cache( get_current_blog_id() );
$used = get_space_used(); // 使用済み容量(MB)を再計算して取得
ディスク容量を再取得する際にセットで使います。
upload_is_user_over_quota()
clean_dirsize_cache( $blog_id );
if ( upload_is_user_over_quota() ) {
echo '容量制限を超えています。';
}
容量オーバー判定の前にキャッシュをクリアして精度を上げる。
switch_to_blog()
/ restore_current_blog()
switch_to_blog( $other_blog_id );
clean_dirsize_cache( $other_blog_id );
restore_current_blog();
他サイトのキャッシュを操作する際に必要。
想定されるトラブル
アップロードしたのに容量が更新されない
FTP経由や一括アップロードツールでファイルを追加した場合、キャッシュが更新されない。
解決方法
clean_dirsize_cache()
を使用してキャッシュを明示的に削除。
容量制限を超えていないのにアップロードできない
古いキャッシュが残っていて、容量オーバーと誤認される。
解決方法
clean_dirsize_cache()
+ get_space_used()
をセットで使って確認。
Q&A
まとめ
clean_dirsize_cache()
は、WordPressマルチサイトにおけるディレクトリサイズのキャッシュを削除し、正確なディスク使用状況を再取得するために重要な関数です。
手動アップロードや不一致の解消、容量チェックの精度向上のために活用されます。特に、容量制限を運用している環境では、get_space_used()
や upload_is_user_over_quota()
とセットで使うことで、正確なストレージ管理が可能となります。
コメント