check_upload_size( array $file ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$filearray

An element from the $_FILES array for a given file.

Return value

array

The $_FILES array element with 'error' key set if file exceeds quota. 'error' is empty otherwise.

Performance profile

How much work a call to check_upload_size() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via filesize().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

6–84

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 87.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• optionnetwork optionget_site_option()called directly
• filesystemfilesystem accessfilesize()called directly
• hookthird-party callbacksapply_filters()one call below check_upload_size()

Further down the call graph this can also reach cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 25 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost check_upload_size() can have, taken from its control-flow graph on PHP 8.5.

Uses · 6

• get_site_option()Retrieve an option value for the current network based on name of option.
• get_upload_space_available()Determines if there is any upload space left in the current blog's quota.
• __()Retrieves the translation of $text.
• upload_is_user_over_quota()Checks whether a site has used its allotted upload space.
• wp_doing_ajax()Determines whether the current request is a WordPress Ajax request.
• wp_die()Kills WordPress execution and displays HTML page with an error message.

Source code

View on Trac ↗View on GitHub ↗

18function check_upload_size( $file ) {19	if ( get_site_option( 'upload_space_check_disabled' ) ) {20		return $file;21	}22 23	if ( $file['error'] > 0 ) { // There's already an error.24		return $file;25	}26 27	if ( defined( 'WP_IMPORTING' ) ) {28		return $file;29	}30 31	$space_left = get_upload_space_available();32 33	$file_size = filesize( $file['tmp_name'] );34	if ( $space_left < $file_size ) {35		/* translators: %s: Required disk space in kilobytes. */36		$file['error'] = sprintf( __( 'Not enough space to upload. %s KB needed.' ), number_format( ( $file_size - $space_left ) / KB_IN_BYTES ) );37	}38 39	if ( $file_size > ( KB_IN_BYTES * get_site_option( 'fileupload_maxk', 1500 ) ) ) {40		/* translators: %s: Maximum allowed file size in kilobytes. */41		$file['error'] = sprintf( __( 'This file is too big. Files must be less than %s KB in size.' ), get_site_option( 'fileupload_maxk', 1500 ) );42	}43 44	if ( upload_is_user_over_quota( false ) ) {45		$file['error'] = __( 'You have used your space quota. Please delete files before uploading.' );46	}47 48	if ( $file['error'] > 0 && ! isset( $_POST['html-upload'] ) && ! wp_doing_ajax() ) {49		wp_die( $file['error'] . ' <a href="javascript:history.go(-1)">' . __( 'Back' ) . '</a>' );50	}51 52	return $file;53}

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/ms.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.