get_space_allowed(): int
- Since
- MU (3.0.0)
- Source
wp-includes/ms-functions.php:2614
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.
Return value
int- Quota in megabytes.
Performance profile
How much work a call to get_space_allowed() 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
- 13–18
- Plugin surface
- 1 hook
- Called by
- 7
Reads stored settings via get_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 18.
Third-party callbacks on 'get_space_allowed' run inside this call, and their cost is not bounded by anything here.
7 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - cacheobject cache
wp_cache_get()one call below get_space_allowed() - serializeserialisation
maybe_unserialize()one call below get_space_allowed()
Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_space_allowed() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$space_allowed | 13–14 | get_option(), apply_filters() |
!$space_allowed | 17–18 | get_option(), get_site_option(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 18 | 13–18 | 2 | |
| 8.5 | 18 | 13–18 | 2 | |
| 8.4 | 18 | 13–18 | 2 | 4 fewer instructions than PHP 8.3 |
| 8.3 | 22 | 17–22 | 2 | |
| 8.2 | 22 | 17–22 | 2 | |
| 8.1 | 22 | 17–22 | 2 | |
| 7.4 | 22 | 17–22 | 2 |
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.
Hooks and filters fired · 1
One hook fires while get_space_allowed() runs, in this order:
- apply_filters( get_space_allowed )filterline 2632 (+18 into the body)
Filters the upload quota for the current site.
Uses · 3
- get_option()Retrieves an option value based on an option name.
- get_site_option()Retrieve an option value for the current network based on name of option.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 7
- display_space_usage()Displays the amount of disk space used by the current site. Not used in core.
- get_upload_space_available()Determines if there is any upload space left in the current blog's quota.
- multisite_over_quota_message()Displays the out of storage quota message in Multisite.
- upload_is_user_over_quota()Checks whether a site has used its allotted upload space.
- wp_dashboard_quota()Displays file upload quota on dashboard.
- wp_xmlrpc_server::mw_newMediaObject()Uploads a file, following your settings.
- wpmu_checkAvailableSpace()Determines if the available space defined by the admin has been exceeded by the user.
Source code
function get_space_allowed() { $space_allowed = get_option( 'blog_upload_space' ); if ( ! is_numeric( $space_allowed ) ) { $space_allowed = get_site_option( 'blog_upload_space' ); } if ( ! is_numeric( $space_allowed ) ) { $space_allowed = 100; } /** * Filters the upload quota for the current site. * * @since 3.7.0 * * @param int $space_allowed Upload quota in megabytes for the current blog. */ return apply_filters( 'get_space_allowed', $space_allowed );}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.8.8 tag, from
src/wp-includes/ms-functions.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.