wp_delete_attachment_files( int $post_id, array $meta, array $backup_sizes, string $file ): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$post_idint

Attachment ID.

$metaarray

The attachment's meta data.

$backup_sizesarray

The meta data for the attachment's backup images.

$filestring

Absolute path to the attachment's file.

Return value

bool

True on success, false on failure.

Performance profile

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

Reaches the database via ->get_row().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

25–133

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

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

• sqldatabase query->get_row()called directly

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

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

Uses · 4

• wp_get_upload_dir()Retrieves uploads directory information.
• wp_basename()i18n-friendly version of basename().
• path_join()Joins two filesystem paths together.
• wp_delete_file_from_directory()Deletes a file if its path is within the given directory.

Used by · 1

• wp_delete_attachment()Trashes or deletes an attachment.

Source code

View on Trac ↗View on GitHub ↗

6653function wp_delete_attachment_files( $post_id, $meta, $backup_sizes, $file ) {6654	global $wpdb;6655 6656	$uploadpath = wp_get_upload_dir();6657	$deleted    = true;6658 6659	if ( ! empty( $meta['thumb'] ) ) {6660		// Don't delete the thumb if another attachment uses it.6661		if ( ! $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE %s AND post_id <> %d", '%' . $wpdb->esc_like( $meta['thumb'] ) . '%', $post_id ) ) ) {6662			$thumbfile = str_replace( wp_basename( $file ), $meta['thumb'], $file );6663 6664			if ( ! empty( $thumbfile ) ) {6665				$thumbfile = path_join( $uploadpath['basedir'], $thumbfile );6666				$thumbdir  = path_join( $uploadpath['basedir'], dirname( $file ) );6667 6668				if ( ! wp_delete_file_from_directory( $thumbfile, $thumbdir ) ) {6669					$deleted = false;6670				}6671			}6672		}6673	}6674 6675	// Remove intermediate and backup images if there are any.6676	if ( isset( $meta['sizes'] ) && is_array( $meta['sizes'] ) ) {6677		$intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );6678 6679		foreach ( $meta['sizes'] as $size => $sizeinfo ) {6680			$intermediate_file = str_replace( wp_basename( $file ), $sizeinfo['file'], $file );6681 6682			if ( ! empty( $intermediate_file ) ) {6683				$intermediate_file = path_join( $uploadpath['basedir'], $intermediate_file );6684 6685				if ( ! wp_delete_file_from_directory( $intermediate_file, $intermediate_dir ) ) {6686					$deleted = false;6687				}6688			}6689		}6690	}6691 6692	if ( ! empty( $meta['original_image'] ) ) {6693		if ( empty( $intermediate_dir ) ) {6694			$intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );6695		}6696 6697		$original_image = str_replace( wp_basename( $file ), $meta['original_image'], $file );6698 6699		if ( ! empty( $original_image ) ) {6700			$original_image = path_join( $uploadpath['basedir'], $original_image );6701 6702			if ( ! wp_delete_file_from_directory( $original_image, $intermediate_dir ) ) {6703				$deleted = false;6704			}6705		}6706	}6707 6708	if ( is_array( $backup_sizes ) ) {6709		$del_dir = path_join( $uploadpath['basedir'], dirname( $meta['file'] ) );6710 6711		foreach ( $backup_sizes as $size ) {6712			$del_file = path_join( dirname( $meta['file'] ), $size['file'] );6713 6714			if ( ! empty( $del_file ) ) {6715				$del_file = path_join( $uploadpath['basedir'], $del_file );6716 6717				if ( ! wp_delete_file_from_directory( $del_file, $del_dir ) ) {6718					$deleted = false;6719				}6720			}6721		}6722	}6723 6724	if ( ! wp_delete_file_from_directory( $file, $uploadpath['basedir'] ) ) {6725		$deleted = false;6726	}6727 6728	return $deleted;6729}

Changelog

Introduced in 4.9.7. 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 6.7.7 tag, from src/wp-includes/post.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.