函数文档

fix_import_form_size()

💡 云策文档标注

概述

fix_import_form_size() 函数用于获取当前站点的剩余上传空间,并基于用户配额限制返回最大允许上传大小。它通过检查用户是否超出配额和可用空间来计算结果。

关键要点

  • 函数接受一个整数参数 $size,表示当前最大上传大小(以字节为单位)。
  • 如果用户已超出上传配额(通过 upload_is_user_over_quota() 检查),则返回 0。
  • 否则,使用 get_upload_space_available() 获取剩余可用空间,并返回 $size 和可用空间中的较小值。
  • 该函数在 WordPress MU 3.0.0 版本中引入,主要用于多站点环境。

代码示例

function fix_import_form_size( $size ) {
    if ( upload_is_user_over_quota( false ) ) {
        return 0;
    }
    $available = get_upload_space_available();
    return min( $size, $available );
}

注意事项

  • 此函数依赖于 upload_is_user_over_quota() 和 get_upload_space_available(),这些函数定义在 wp-admin/includes/ms.php 和 wp-includes/ms-functions.php 中。
  • 适用于多站点(Multisite)配置,用于管理用户上传配额。

📄 原文内容

Gets the remaining upload space for this site.

Parameters

$sizeintrequired
Current max size in bytes.

Return

int Max size in bytes.

Source

function fix_import_form_size( $size ) {
	if ( upload_is_user_over_quota( false ) ) {
		return 0;
	}
	$available = get_upload_space_available();
	return min( $size, $available );
}

Changelog

Version Description
MU (3.0.0) Introduced.