wppaste
WordPress

File_Upload_Upgrader::cleanup(): bool

Since
3.2.2
Source
wp-admin/includes/class-file-upload-upgrader.php:148
Deletes the attachment/uploaded file.

Compatibility

WordPress
since 3.2.2
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

bool
Whether the cleanup was successful.

Performance profile

How much work a call to File_Upload_Upgrader::cleanup() 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 file_exists().

Scaling
Constant

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

Instructions
8–14

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

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

What it touches

  • filesystemfilesystem accessfile_exists()called directly
  • querycontent queryget_post()one call below File_Upload_Upgrader::cleanup()
  • hookthird-party callbacksapply_filters()one call below File_Upload_Upgrader::cleanup()

Further down the call graph this can also reach transient, serialize, cache and option. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

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

WhenInstructionsCalls it makes
!file_exists()8file_exists()
always8wp_delete_attachment()
file_exists()14file_exists(), unlink()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 21 instructions, 8–14 executed per call, 2 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.

Uses · 1

Source code

View on Trac View on GitHub 

	public function cleanup() {		if ( $this->id ) {			wp_delete_attachment( $this->id ); 		} elseif ( file_exists( $this->package ) ) {			return @unlink( $this->package );		} 		return true;	}

Changelog

Introduced in 3.2.2. 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.1.0 tag, from src/wp-admin/includes/class-file-upload-upgrader.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.