WP_REST_Attachments_Controller::create_item_permissions_check( WP_REST_Request $request ): true|WP_Error
- Since
- 4.7.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php:404
Compatibility
- WordPress
- since 4.7.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
$requestWP_REST_Request- Full details about the request.
Return value
true|WP_Error- Boolean true if the attachment may be created, or a WP_Error if not.
Performance profile
How much work a call to WP_REST_Attachments_Controller::create_item_permissions_check() 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
- 7–80
- Plugin surface
- 1 hook
- Called by
- 0
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 103.
Third-party callbacks on 'wp_prevent_unsupported_mime_type_uploads' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach cache, query, option, serialize 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 · 10 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Attachments_Controller::create_item_permissions_check() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7 | ::create_item_permissions_check() |
is_wp_error() | 11 | ::create_item_permissions_check(), is_wp_error() |
!is_wp_error() && !current_user_can() | 23 | ::create_item_permissions_check(), is_wp_error(), current_user_can(), __() |
!is_wp_error() && current_user_can() && empty($request) | 33–58 | ::create_item_permissions_check(), is_wp_error(), current_user_can(), ->get_file_params(), apply_filters(), wp_is_client_side_media_processing_enabled() |
!is_wp_error() && !empty($request) | 35 | ::create_item_permissions_check(), is_wp_error(), current_user_can(), current_user_can(), __(), rest_authorization_required_code(), status() |
!is_wp_error() && current_user_can() && !empty($request) | 40–65 | ::create_item_permissions_check(), is_wp_error(), current_user_can(), current_user_can(), ->get_file_params(), apply_filters(), wp_is_client_side_media_processing_enabled() |
!is_wp_error() && current_user_can() && empty($request) && isset($value) && mime_type() | 55–65 | ::create_item_permissions_check(), is_wp_error(), current_user_can(), ->get_file_params(), apply_filters(), wp_is_client_side_media_processing_enabled(), mime_type() |
!is_wp_error() && current_user_can() && !empty($request) && isset($value) && mime_type() | 62–72 | ::create_item_permissions_check(), is_wp_error(), current_user_can(), current_user_can(), ->get_file_params(), apply_filters(), wp_is_client_side_media_processing_enabled(), mime_type() |
!is_wp_error() && current_user_can() && empty($request) && isset($value) && !mime_type() | 63–73 | ::create_item_permissions_check(), is_wp_error(), current_user_can(), ->get_file_params(), apply_filters(), wp_is_client_side_media_processing_enabled(), mime_type(), __(), wp_image_editor_supports() |
!is_wp_error() && current_user_can() && !empty($request) && isset($value) && !mime_type() | 70–80 | ::create_item_permissions_check(), is_wp_error(), current_user_can(), current_user_can(), ->get_file_params(), apply_filters(), wp_is_client_side_media_processing_enabled(), mime_type(), __(), wp_image_editor_supports() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 103 | 7–80 | 16 | |
| 8.5 | 103 | 7–80 | 16 | |
| 8.4 | 103 | 7–80 | 16 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 106 | 7–83 | 16 | |
| 8.2 | 106 | 7–83 | 16 | |
| 8.1 | 106 | 7–83 | 16 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 107 | 7–84 | 16 |
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_REST_Attachments_Controller::create_item_permissions_check() runs, in this order:
- apply_filters( wp_prevent_unsupported_mime_type_uploads )filterline 440 (+36 into the body)
Filter whether the server should prevent uploads for image types it doesn't support. Default true.
Uses · 10
- is_wp_error()Checks whether the given variable is a WordPress Error.
- current_user_can()Returns whether the current user has the specified capability.
- __()Retrieves the translation of $text.
- rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- wp_is_client_side_media_processing_enabled()Checks whether client-side media processing is enabled.
- str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
- wp_image_editor_supports()Tests whether there is an editor that supports a given mime type or methods.
- WP_REST_Posts_Controller::create_item_permissions_check()Checks if a given request has access to create a post.
- WP_Error::__construct()Initializes the error.
Source code
public function create_item_permissions_check( $request ) { $ret = parent::create_item_permissions_check( $request ); if ( ! $ret || is_wp_error( $ret ) ) { return $ret; } if ( ! current_user_can( 'upload_files' ) ) { return new WP_Error( 'rest_cannot_create', __( 'Sorry, you are not allowed to upload media on this site.' ), array( 'status' => 400 ) ); } // Attaching media to a post requires ability to edit said post. if ( ! empty( $request['post'] ) && ! current_user_can( 'edit_post', (int) $request['post'] ) ) { return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to upload media to this post.' ), array( 'status' => rest_authorization_required_code() ) ); } $files = $request->get_file_params(); /** * Filter whether the server should prevent uploads for image types it doesn't support. Default true. * * Developers can use this filter to enable uploads of certain image types. By default image types that are not * supported by the server are prevented from being uploaded. * * @since 6.8.0 * * @param bool $check_mime Whether to prevent uploads of unsupported image types. * @param string|null $mime_type The mime type of the file being uploaded (if available). */ $prevent_unsupported_uploads = apply_filters( 'wp_prevent_unsupported_mime_type_uploads', true, $files['file']['type'] ?? null ); /* * When the client handles image processing (generate_sub_sizes is false), * skip the server-side image editor support check. This check exists * because the server cannot process the image, so it is only relaxed when * client side media processing is enabled and something else can. Asking * to skip sub sizes on a site without it does not make an unsupported * image type any more usable. */ if ( wp_is_client_side_media_processing_enabled() && false === $request['generate_sub_sizes'] ) { $prevent_unsupported_uploads = false; } /* * Always allow still HEIC/HEIF uploads through even if the server's * image editor doesn't support them. The client-side canvas fallback * handles processing using the browser's native HEVC decoder. * * The '-sequence' variants (multi-frame Live Photos) are deliberately * excluded: neither the server nor the browser fallback can process * them yet, so they should fall through to the standard unsupported * mime-type error rather than be stored unprocessable. */ $still_heic_mime_types = array( 'image/heic', 'image/heif' ); if ( $prevent_unsupported_uploads && ! empty( $files['file']['type'] ) && in_array( $files['file']['type'], $still_heic_mime_types, true ) ) { $prevent_unsupported_uploads = false; } // If the upload is an image, check if the server can handle the mime type. if ( $prevent_unsupported_uploads && isset( $files['file']['type'] ) && str_starts_with( $files['file']['type'], 'image/' ) ) { // List of non-resizable image formats. $editor_non_resizable_formats = array( 'image/svg+xml', );Changelog
Introduced in 4.7.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 7.1.0 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.