WP_REST_Attachments_Controller::check_upload_size( array $file ): true|WP_Error
- Since
- 4.9.8
- Source
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php:1573
Description
Replicates check_upload_size().
Compatibility
- WordPress
- since 4.9.8
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$filearray- $_FILES array for a given file.
Return value
true|WP_Error- True if can upload, error for errors.
Performance profile
How much work a call to WP_REST_Attachments_Controller::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
- Scaling
- Constant
- Instructions
- 5–43
- Plugin surface
- None
- Called by
- 2
Reads or writes the filesystem via filesize().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 81.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionnetwork option
get_site_option()called directly - filesystemfilesystem access
filesize()called directly
Further down the call graph this can also reach hook, 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 · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Attachments_Controller::check_upload_size() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_multisite() | 5 | is_multisite() |
is_multisite() && get_site_option() | 9 | is_multisite(), get_site_option() |
is_multisite() && !get_site_option() && !$space_left && !$file_size && !upload_is_user_over_quota() | 34 | is_multisite(), get_site_option(), get_upload_space_available(), filesize(), get_site_option(), upload_is_user_over_quota() |
is_multisite() && !get_site_option() && $space_left | 37 | is_multisite(), get_site_option(), get_upload_space_available(), filesize(), __(), number_format(), sprintf() |
is_multisite() && !get_site_option() && !$space_left && !$file_size && upload_is_user_over_quota() | 42 | is_multisite(), get_site_option(), get_upload_space_available(), filesize(), get_site_option(), upload_is_user_over_quota(), __() |
is_multisite() && !get_site_option() && !$space_left && $file_size | 43 | is_multisite(), get_site_option(), get_upload_space_available(), filesize(), get_site_option(), __(), get_site_option(), sprintf() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 81 instructions, 5–43 executed per call, 5 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 6
- is_multisite()Determines whether Multisite is enabled.
- 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_Error::__construct()Initializes the error.
Used by · 2
- WP_REST_Attachments_Controller::upload_from_data()Handles an upload via raw POST data.
- WP_REST_Attachments_Controller::upload_from_file()Handles an upload via multipart/form-data ($_FILES).
Source code
protected function check_upload_size( $file ) { if ( ! is_multisite() ) { return true; } if ( get_site_option( 'upload_space_check_disabled' ) ) { return true; } $space_left = get_upload_space_available(); $file_size = filesize( $file['tmp_name'] ); if ( $space_left < $file_size ) { return new WP_Error( 'rest_upload_limited_space', /* translators: %s: Required disk space in kilobytes. */ sprintf( __( 'Not enough space to upload. %s KB needed.' ), number_format( ( $file_size - $space_left ) / KB_IN_BYTES ) ), array( 'status' => 400 ) ); } if ( $file_size > ( KB_IN_BYTES * get_site_option( 'fileupload_maxk', 1500 ) ) ) { return new WP_Error( 'rest_upload_file_too_big', /* translators: %s: Maximum allowed file size in kilobytes. */ sprintf( __( 'This file is too big. Files must be less than %s KB in size.' ), get_site_option( 'fileupload_maxk', 1500 ) ), array( 'status' => 400 ) ); } // Include multisite admin functions to get access to upload_is_user_over_quota(). require_once ABSPATH . 'wp-admin/includes/ms.php'; if ( upload_is_user_over_quota( false ) ) { return new WP_Error( 'rest_upload_user_quota_exceeded', __( 'You have used your space quota. Please delete files before uploading.' ), array( 'status' => 400 ) ); } return true; }Changelog
Introduced in 4.9.8. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.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.