wp_is_client_side_media_processing_enabled(): bool
- Since
- 7.1.0
- Source
wp-includes/media.php:6580
Description
Client-side media processing uses the browser's capabilities to handle tasks like image resizing and compression before uploading to the server.
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Return value
bool- Whether client-side media processing is enabled.
Performance profile
How much work a call to wp_is_client_side_media_processing_enabled() 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
- Trivial
- Scaling
- Constant
- Instructions
- 22–30
- Plugin surface
- 1 hook
- Called by
- 6
Touches nothing outside its own arguments.
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 30.
Third-party callbacks on 'wp_client_side_media_processing_enabled' run inside this call, and their cost is not bounded by anything here.
6 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
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 wp_is_client_side_media_processing_enabled() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 22–25 | strtok(), strtolower(), is_ssl(), apply_filters() |
!is_ssl() && $host !== "localhost" | 29–30 | strtok(), strtolower(), is_ssl(), str_ends_with(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 30 instructions, 22–30 executed per call, 3 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.
Hooks and filters fired · 1
One hook fires while wp_is_client_side_media_processing_enabled() runs, in this order:
- apply_filters( wp_client_side_media_processing_enabled )filterline 6592 (+12 into the body)
Filters whether client-side media processing is enabled.
Uses · 3
- is_ssl()Determines if SSL is used.
- str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 6
- WP_REST_Attachments_Controller::create_item_permissions_check()Checks if a given request has access to create an attachment.
- WP_REST_Attachments_Controller::register_routes()Registers the routes for attachments.
- WP_REST_Server::get_index()Retrieves the site index.
- wp_print_media_templates()Prints the templates used in the media manager.
- wp_set_client_side_media_processing_flag()Sets a global JS variable to indicate that client-side media processing is enabled.
- wp_set_up_cross_origin_isolation()Enables cross-origin isolation in the block editor.
Source code
function wp_is_client_side_media_processing_enabled(): bool { // This is due to SharedArrayBuffer requiring a secure context. $host = strtolower( (string) strtok( $_SERVER['HTTP_HOST'] ?? '', ':' ) ); $enabled = ( is_ssl() || 'localhost' === $host || str_ends_with( $host, '.localhost' ) ); /** * Filters whether client-side media processing is enabled. * * @since 7.1.0 * * @param bool $enabled Whether client-side media processing is enabled. Default true if the page is served in a secure context. */ return (bool) apply_filters( 'wp_client_side_media_processing_enabled', $enabled );}Changelog
Introduced in 7.1.0.
Signature, return type and hooks compared across 1 parsed release.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/media.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.