WP_REST_Attachments_Controller::upload_from_data( string $data, array $headers, string|null $time = null ): array|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

$datastring

Supplied file data.

$headersarray

HTTP headers from the request.

$timestring|nulloptional

Time formatted in 'yyyy/mm'. Default null.Default: null

Return value

array|WP_Error

Data from wp_handle_sideload().

Performance profile

How much work a call to WP_REST_Attachments_Controller::upload_from_data() 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

Heavy

Reads or writes the filesystem via fopen().

Scaling

Constant

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

Instructions

14–92

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• filesystemfilesystem accessfopen()called directly
• hookthird-party callbacksdo_action()one call below WP_REST_Attachments_Controller::upload_from_data()

Further down the call graph this can also reach transient, cache, option, serialize 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 · 11 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Attachments_Controller::upload_from_data() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• __()Retrieves the translation of $text.
• wp_tempnam()Returns a filename of a temporary unique file.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_handle_sideload()Wrapper for _wp_handle_upload().
• WP_Error::__construct()Initializes the error.
• WP_REST_Attachments_Controller::get_filename_from_disposition()Parses filename from a Content-Disposition header value.
• WP_REST_Attachments_Controller::check_upload_size()Determine if uploaded file exceeds space quota on multisite.

Used by · 1

• WP_REST_Attachments_Controller::insert_attachment()Inserts the attachment post in the database. Does not update the attachment meta.

Source code

View on Trac ↗View on GitHub ↗

1180	protected function upload_from_data( $data, $headers, $time = null ) {1181		if ( empty( $data ) ) {1182			return new WP_Error(1183				'rest_upload_no_data',1184				__( 'No data supplied.' ),1185				array( 'status' => 400 )1186			);1187		}1188 1189		if ( empty( $headers['content_type'] ) ) {1190			return new WP_Error(1191				'rest_upload_no_content_type',1192				__( 'No Content-Type supplied.' ),1193				array( 'status' => 400 )1194			);1195		}1196 1197		if ( empty( $headers['content_disposition'] ) ) {1198			return new WP_Error(1199				'rest_upload_no_content_disposition',1200				__( 'No Content-Disposition supplied.' ),1201				array( 'status' => 400 )1202			);1203		}1204 1205		$filename = self::get_filename_from_disposition( $headers['content_disposition'] );1206 1207		if ( empty( $filename ) ) {1208			return new WP_Error(1209				'rest_upload_invalid_disposition',1210				__( 'Invalid Content-Disposition supplied. Content-Disposition needs to be formatted as `attachment; filename="image.png"` or similar.' ),1211				array( 'status' => 400 )1212			);1213		}1214 1215		if ( ! empty( $headers['content_md5'] ) ) {1216			$content_md5 = array_shift( $headers['content_md5'] );1217			$expected    = trim( $content_md5 );1218			$actual      = md5( $data );1219 1220			if ( $expected !== $actual ) {1221				return new WP_Error(1222					'rest_upload_hash_mismatch',1223					__( 'Content hash did not match expected.' ),1224					array( 'status' => 412 )1225				);1226			}1227		}1228 1229		// Get the content-type.1230		$type = array_shift( $headers['content_type'] );1231 1232		// Include filesystem functions to get access to wp_tempnam() and wp_handle_sideload().1233		require_once ABSPATH . 'wp-admin/includes/file.php';1234 1235		// Save the file.1236		$tmpfname = wp_tempnam( $filename );1237 1238		$fp = fopen( $tmpfname, 'w+' );1239 1240		if ( ! $fp ) {1241			return new WP_Error(1242				'rest_upload_file_error',1243				__( 'Could not open file handle.' ),1244				array( 'status' => 500 )1245			);1246		}1247 1248		fwrite( $fp, $data );1249		fclose( $fp );1250 1251		// Now, sideload it in.1252		$file_data = array(1253			'error'    => null,1254			'tmp_name' => $tmpfname,1255			'name'     => $filename,1256			'type'     => $type,1257		);1258 1259		$size_check = self::check_upload_size( $file_data );

Changelog

Introduced in 4.7.0. One change between 6.7.7 and 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 6.9.7 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.