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

29–130

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

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 · 105 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.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

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 ↗

6918function wp_delete_attachment_files( $post_id, $meta, $backup_sizes, $file ) {6919	global $wpdb;6920 6921	$uploadpath = wp_get_upload_dir();6922	$deleted    = true;6923 6924	if ( ! empty( $meta['thumb'] ) ) {6925		// Don't delete the thumb if another attachment uses it.6926		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 ) ) ) {6927			$thumbfile = str_replace( wp_basename( $file ), $meta['thumb'], $file );6928 6929			if ( ! empty( $thumbfile ) ) {6930				$thumbfile = path_join( $uploadpath['basedir'], $thumbfile );6931				$thumbdir  = path_join( $uploadpath['basedir'], dirname( $file ) );6932 6933				if ( ! wp_delete_file_from_directory( $thumbfile, $thumbdir ) ) {6934					$deleted = false;6935				}6936			}6937		}6938	}6939 6940	// Remove intermediate and backup images if there are any.6941	if ( isset( $meta['sizes'] ) && is_array( $meta['sizes'] ) ) {6942		$intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );6943 6944		foreach ( $meta['sizes'] as $size => $sizeinfo ) {6945			$intermediate_file = str_replace( wp_basename( $file ), $sizeinfo['file'], $file );6946 6947			if ( ! empty( $intermediate_file ) ) {6948				$intermediate_file = path_join( $uploadpath['basedir'], $intermediate_file );6949 6950				if ( ! wp_delete_file_from_directory( $intermediate_file, $intermediate_dir ) ) {6951					$deleted = false;6952				}6953			}6954		}6955	}6956 6957	if ( ! empty( $meta['original_image'] ) ) {6958		if ( empty( $intermediate_dir ) ) {6959			$intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );6960		}6961 6962		$original_image = str_replace( wp_basename( $file ), $meta['original_image'], $file );6963 6964		if ( ! empty( $original_image ) ) {6965			$original_image = path_join( $uploadpath['basedir'], $original_image );6966 6967			if ( ! wp_delete_file_from_directory( $original_image, $intermediate_dir ) ) {6968				$deleted = false;6969			}6970		}6971	}6972 6973	/*6974	 * Delete the source-format companion file. The client-side media flow can6975	 * sideload a source-format original (such as a HEIC file) alongside a6976	 * web-viewable derivative, recording its filename under the 'source_image'6977	 * key. This is kept separate from 'original_image', which continues to6978	 * point at the derivative.6979	 */6980	if ( ! empty( $meta['source_image'] ) && is_string( $meta['source_image'] ) ) {6981		if ( empty( $intermediate_dir ) ) {6982			$intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );6983		}6984 6985		$source_image = str_replace( wp_basename( $file ), $meta['source_image'], $file );6986 6987		if ( ! empty( $source_image ) ) {6988			$source_image = path_join( $uploadpath['basedir'], $source_image );6989 6990			if ( ! wp_delete_file_from_directory( $source_image, $intermediate_dir ) ) {6991				$deleted = false;6992			}6993		}6994	}6995 6996	/*6997	 * Delete the animated-GIF video companions. When the client-side media flow

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