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

Deletes all files that belong to the given attachment.

Parameters

$post_id

(Required) Attachment ID.

$meta

(Required) The attachment's meta data.

$backup_sizes

(Required) The meta data for the attachment's backup images.

$file

(Required) Absolute path to the attachment's file.

Return

(bool) True on success, false on failure.

Source

File: wp-includes/post.php 

function wp_delete_attachment_files( $post_id, $meta, $backup_sizes, $file ) {
	global $wpdb;

	$uploadpath = wp_get_upload_dir();
	$deleted    = true;

	if ( ! empty( $meta['thumb'] ) ) {
		// Don't delete the thumb if another attachment uses it.
		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 ) ) ) {
			$thumbfile = str_replace( basename( $file ), $meta['thumb'], $file );
			if ( ! empty( $thumbfile ) ) {
				$thumbfile = path_join( $uploadpath['basedir'], $thumbfile );
				$thumbdir  = path_join( $uploadpath['basedir'], dirname( $file ) );

				if ( ! wp_delete_file_from_directory( $thumbfile, $thumbdir ) ) {
					$deleted = false;
				}
			}
		}
	}

	// Remove intermediate and backup images if there are any.
	if ( isset( $meta['sizes'] ) && is_array( $meta['sizes'] ) ) {
		$intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );
		foreach ( $meta['sizes'] as $size => $sizeinfo ) {
			$intermediate_file = str_replace( basename( $file ), $sizeinfo['file'], $file );
			if ( ! empty( $intermediate_file ) ) {
				$intermediate_file = path_join( $uploadpath['basedir'], $intermediate_file );

				if ( ! wp_delete_file_from_directory( $intermediate_file, $intermediate_dir ) ) {
					$deleted = false;
				}
			}
		}
	}

	if ( is_array( $backup_sizes ) ) {
		$del_dir = path_join( $uploadpath['basedir'], dirname( $meta['file'] ) );
		foreach ( $backup_sizes as $size ) {
			$del_file = path_join( dirname( $meta['file'] ), $size['file'] );
			if ( ! empty( $del_file ) ) {
				$del_file = path_join( $uploadpath['basedir'], $del_file );

				if ( ! wp_delete_file_from_directory( $del_file, $del_dir ) ) {
					$deleted = false;
				}
			}
		}
	}

	if ( ! wp_delete_file_from_directory( $file, $uploadpath['basedir'] ) ) {
		$deleted = false;
	}

	return $deleted;
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/wp-db.php: wpdb::get_row()

Retrieve one row from the database.
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
wp-includes/wp-db.php: wpdb::esc_like()

First half of escaping for LIKE special characters % and _ before preparing for MySQL.
wp-includes/functions.php: wp_delete_file_from_directory()

Deletes a file if its path is within the given directory.
wp-includes/functions.php: wp_get_upload_dir()

Retrieves uploads directory information.
wp-includes/functions.php: path_join()

Join two filesystem paths together.
Show 1 more use Hide more uses

Used By

Used By
Used By Description
wp-includes/post.php: wp_delete_attachment()

Trash or delete an attachment.

Changelog

Changelog
Version Description
WP-4.9.7 Introduced.