upload_is_user_over_quota( bool $display_message = true ): bool
- Since
- MU (3.0.0)
- Source
wp-admin/includes/ms.php:225
Compatibility
- WordPress
- since MU (3.0.0)
- 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
$display_messagebooloptional- If set to true and the quota is exceeded, a warning message is displayed. Default true.Default:
true
Return value
bool- True if user is over upload space quota, otherwise false.
Performance profile
How much work a call to upload_is_user_over_quota() 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
- Moderate
- Scaling
- Constant
- Instructions
- 6–31
- Plugin surface
- None
- Called by
- 5
Reads stored settings via get_site_option(), cached per request but not free on a cold cache.
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 33.
Nothing here hands control to plugin code.
5 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 - hookthird-party callbacks
apply_filters()one call below upload_is_user_over_quota()
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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost upload_is_user_over_quota() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
get_site_option() | 6 | get_site_option() |
!get_site_option() | 17–19 | get_site_option(), get_space_allowed(), get_space_used() |
!get_site_option() | 30–31 | get_site_option(), get_space_allowed(), get_space_used(), __(), size_format(), printf() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 33 | 6–31 | 4 | |
| 8.5 | 33 | 6–31 | 4 | |
| 8.4 | 33 | 6–31 | 4 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 35 | 6–33 | 4 | |
| 8.2 | 35 | 6–33 | 4 | |
| 8.1 | 35 | 6–33 | 4 | |
| 7.4 | 35 | 6–33 | 4 |
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 · 5
- get_site_option()Retrieve an option value for the current network based on name of option.
- get_space_allowed()Returns the upload quota for the current blog.
- get_space_used()Returns the space used by the current site.
- __()Retrieves the translation of $text.
- size_format()Converts a number of bytes to the largest unit the bytes will fit into.
Used by · 5
- WP_Importer::is_user_over_quota()Checks if user has exceeded disk quota.
- WP_REST_Attachments_Controller::check_upload_size()Determine if uploaded file exceeds space quota on multisite.
- check_upload_size()Determines whether uploaded file exceeds space quota.
- fix_import_form_size()Gets the remaining upload space for this site.
- wp_xmlrpc_server::mw_newMediaObject()Uploads a file, following your settings.
Source code
function upload_is_user_over_quota( $display_message = true ) { if ( get_site_option( 'upload_space_check_disabled' ) ) { return false; } $space_allowed = get_space_allowed(); if ( ! is_numeric( $space_allowed ) ) { $space_allowed = 10; // Default space allowed is 10 MB. } $space_used = get_space_used(); if ( ( $space_allowed - $space_used ) < 0 ) { if ( $display_message ) { printf( /* translators: %s: Allowed space allocation. */ __( 'Sorry, you have used your space allocation of %s. Please delete some files to upload more files.' ), size_format( $space_allowed * MB_IN_BYTES ) ); } return true; } else { return false; }}Changelog
Introduced in MU (3.0.0). 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 6.7.7 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.