函数文档

wp_delete_attachment_files()

💡 云策文档标注

概述

wp_delete_attachment_files() 函数用于删除指定附件及其相关文件,包括缩略图、中间尺寸图像、原始图像和备份图像。它通过检查数据库确保不删除其他附件共享的缩略图,并返回操作成功与否的布尔值。

关键要点

  • 函数接收四个必需参数:附件 ID、元数据数组、备份尺寸数组和文件绝对路径。
  • 删除过程包括缩略图(需检查是否被其他附件使用)、中间尺寸图像、原始图像和备份图像。
  • 使用 wp_delete_file_from_directory() 等辅助函数安全删除文件,并返回 true 表示成功,false 表示失败。
  • 函数自 WordPress 4.9.7 版本引入,主要用于 wp_delete_attachment() 中。

代码示例

function wp_delete_attachment_files( $post_id, $meta, $backup_sizes, $file ) {
    global $wpdb;
    $uploadpath = wp_get_upload_dir();
    $deleted    = true;
    // 删除缩略图(检查是否被其他附件使用)
    if ( ! empty( $meta['thumb'] ) ) {
        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( wp_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;
                }
            }
        }
    }
    // 删除中间尺寸图像
    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( wp_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 ( ! empty( $meta['original_image'] ) ) {
        if ( empty( $intermediate_dir ) ) {
            $intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );
        }
        $original_image = str_replace( wp_basename( $file ), $meta['original_image'], $file );
        if ( ! empty( $original_image ) ) {
            $original_image = path_join( $uploadpath['basedir'], $original_image );
            if ( ! wp_delete_file_from_directory( $original_image, $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;
}

注意事项

  • 函数内部使用数据库查询检查缩略图是否被其他附件使用,避免误删共享资源。
  • 所有文件删除操作都通过 wp_delete_file_from_directory() 进行,确保路径安全。
  • 参数必须准确提供,否则可能导致文件删除失败或意外行为。

📄 原文内容

Deletes all files that belong to the given attachment.

Parameters

$post_idintrequired
Attachment ID.
$metaarrayrequired
The attachment’s meta data.
$backup_sizesarrayrequired
The meta data for the attachment’s backup images.
$filestringrequired
Absolute path to the attachment’s file.

Return

bool True on success, false on failure.

Source

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( wp_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( wp_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 ( ! empty( $meta['original_image'] ) ) {
		if ( empty( $intermediate_dir ) ) {
			$intermediate_dir = path_join( $uploadpath['basedir'], dirname( $file ) );
		}

		$original_image = str_replace( wp_basename( $file ), $meta['original_image'], $file );

		if ( ! empty( $original_image ) ) {
			$original_image = path_join( $uploadpath['basedir'], $original_image );

			if ( ! wp_delete_file_from_directory( $original_image, $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;
}

Changelog

Version Description
4.9.7 Introduced.