WP_REST_Attachments_Controller::create_item_permissions_check( WP_REST_Request $request ): true|WP_Error

Compatibility

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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

7–64

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 87.

Plugin surface

1 hook

Third-party callbacks on 'wp_prevent_unsupported_mime_type_uploads' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_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.

Hooks and filters fired · 1

One hook fires while WP_REST_Attachments_Controller::create_item_permissions_check() runs, in this order:

1. 1
   apply_filters( wp_prevent_unsupported_mime_type_uploads )filterline 162 (+36 into the body)

   Filter whether the server should prevent uploads for image types it doesn't support. Default true.

Uses · 9

• 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.
• 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

View on Trac ↗View on GitHub ↗

126	public function create_item_permissions_check( $request ) {127		$ret = parent::create_item_permissions_check( $request );128 129		if ( ! $ret || is_wp_error( $ret ) ) {130			return $ret;131		}132 133		if ( ! current_user_can( 'upload_files' ) ) {134			return new WP_Error(135				'rest_cannot_create',136				__( 'Sorry, you are not allowed to upload media on this site.' ),137				array( 'status' => 400 )138			);139		}140 141		// Attaching media to a post requires ability to edit said post.142		if ( ! empty( $request['post'] ) && ! current_user_can( 'edit_post', (int) $request['post'] ) ) {143			return new WP_Error(144				'rest_cannot_edit',145				__( 'Sorry, you are not allowed to upload media to this post.' ),146				array( 'status' => rest_authorization_required_code() )147			);148		}149		$files = $request->get_file_params();150 151		/**152		 * Filter whether the server should prevent uploads for image types it doesn't support. Default true.153		 *154		 * Developers can use this filter to enable uploads of certain image types. By default image types that are not155		 * supported by the server are prevented from being uploaded.156		 *157		 * @since 6.8.0158		 *159		 * @param bool        $check_mime Whether to prevent uploads of unsupported image types.160		 * @param string|null $mime_type  The mime type of the file being uploaded (if available).161		 */162		$prevent_unsupported_uploads = apply_filters( 'wp_prevent_unsupported_mime_type_uploads', true, $files['file']['type'] ?? null );163 164		// If the upload is an image, check if the server can handle the mime type.165		if (166			$prevent_unsupported_uploads &&167			isset( $files['file']['type'] ) &&168			str_starts_with( $files['file']['type'], 'image/' )169		) {170			// List of non-resizable image formats.171			$editor_non_resizable_formats = array(172				'image/svg+xml',173			);174 175			// Check if the image editor supports the type or ignore if it isn't a format resizable by an editor.176			if (177				! in_array( $files['file']['type'], $editor_non_resizable_formats, true ) &&178				! wp_image_editor_supports( array( 'mime_type' => $files['file']['type'] ) )179			) {180				return new WP_Error(181					'rest_upload_image_type_not_supported',182					__( 'The web server cannot generate responsive image sizes for this image. Convert it to JPEG or PNG before uploading.' ),183					array( 'status' => 400 )184				);185			}186		}187 188		return true;189	}

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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.