WordPress函数wp_delete_attachment在文件系统与数据库间的同步逻辑 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress 函数 `wp_delete_attachment`：文件系统与数据库间的同步逻辑

大家好，今天我们来深入探讨 WordPress 中一个非常重要的函数：wp_delete_attachment。这个函数的作用是从 WordPress 系统中彻底删除附件，这意味着它不仅要从数据库中删除相关记录，还要从文件系统中移除实际的文件。理解 wp_delete_attachment 的工作原理，对于开发者来说至关重要，可以避免出现文件残留、数据库冗余等问题，保证系统的稳定性和数据的完整性。

`wp_delete_attachment` 函数概览

wp_delete_attachment 函数位于 wp-includes/post.php 文件中。它的主要功能如下：

验证权限： 检查当前用户是否有删除指定附件的权限。
删除附件相关数据库记录： 删除 wp_posts 表中附件的记录，以及 wp_postmeta 表中与附件相关的元数据。
删除附件文件： 从文件系统中删除附件的原始文件以及所有生成的缩略图。
触发钩子： 在删除前后触发 delete_attachment 和 wp_delete_file 钩子，允许开发者自定义删除过程。

函数签名如下：

/**
 * Deletes an attachment.
 *
 * @since 2.0.0
 *
 * @param int  $post_id Post ID.
 * @param bool $force_delete Optional. Whether to bypass Trash. Default false.
 * @return WP_Post|false WP_Post on success, false on failure.
 */
function wp_delete_attachment( $post_id, $force_delete = false ) {
  // 函数体
}

参数说明：

$post_id：要删除的附件的 ID（文章 ID）。
$force_delete：可选参数，默认为 false。如果设置为 true，则绕过回收站，直接永久删除附件。如果设置为 false，附件将被移动到回收站。

返回值：

成功删除附件时，返回一个 WP_Post 对象，代表被删除的附件。
删除失败时，返回 false。

`wp_delete_attachment` 的内部逻辑

接下来，我们深入分析 wp_delete_attachment 函数的内部实现，了解它如何同步数据库和文件系统。

权限验证：

函数首先会检查当前用户是否有 delete_post 权限，如果没有，则直接返回 false。

$post = get_post( $post_id );

if ( ! $post ) {
  return false;
}

if ( ! current_user_can( 'delete_post', $post_id ) ) {
  return false;
}

回收站处理：

如果 $force_delete 为 false，并且回收站功能已启用，则将附件移动到回收站，而不是直接删除。
```
if ( ! $force_delete && EMPTY_TRASH_DAYS && MEDIA_TRASH && 'trash' !== $post->post_status ) {
  return wp_trash_post( $post_id );
}
```
wp_trash_post 函数负责将文章（包括附件）的状态更新为 trash，并将其移动到回收站。
永久删除：

如果 $force_delete 为 true，或者回收站功能未启用，则执行永久删除操作。
- 触发 delete_attachment 钩子：
  
  在删除附件之前，会触发 delete_attachment 钩子，允许开发者在删除操作之前执行自定义逻辑。
```
do_action( 'delete_attachment', $post_id );
```
- 获取附件文件路径：
  
  使用 get_attached_file 函数获取附件的原始文件路径。
```
$file = get_attached_file( $post_id );
```
- 删除附件的元数据：
  
  使用 delete_post_meta 函数删除与附件相关的元数据。 _wp_attached_file 和 _wp_attachment_metadata 这两个元数据键分别存储了附件的文件路径和元数据（例如缩略图信息）。
```
delete_post_meta( $post_id, '_wp_attached_file' );
delete_post_meta( $post_id, '_wp_attachment_metadata' );
```
- 删除附件在数据库中的记录:
  
  使用 wp_delete_post 函数删除 wp_posts 表中附件的记录。 wp_delete_post 函数会同时删除该附件的所有修订版本。
```
$result = wp_delete_post( $post_id, true ); // true 表示强制删除
```
- 删除附件文件：
  
  如果成功删除了附件的数据库记录，则调用 wp_delete_file 函数从文件系统中删除附件的原始文件及其所有缩略图。
```
if ( $result ) {
  wp_delete_file( $file );
}
```
wp_delete_file 函数:

wp_delete_file 函数是删除附件文件的关键。它的逻辑如下：
- 检查文件是否存在：
  
  使用 file_exists 函数检查文件是否存在。
```
if ( ! file_exists( $file ) ) {
  return false;
}
```
- 触发 wp_delete_file 钩子：
  
  在删除文件之前，会触发 wp_delete_file 钩子，允许开发者在删除操作之前执行自定义逻辑。这个钩子可以用于实现例如备份附件的功能。
```
do_action( 'wp_delete_file', $file );
```
- 删除原始文件：
  
  使用 unlink 函数删除原始文件。
```
$deleted = @unlink( $file );
```
- 删除缩略图：
  
  如果附件有缩略图，则删除所有缩略图。缩略图的信息存储在附件的元数据 _wp_attachment_metadata 中。 wp_get_attachment_metadata 函数用于获取附件的元数据。
```
$meta = wp_get_attachment_metadata( $attachment_id );

if ( ! empty( $meta['sizes'] ) ) {
  $upload_dir = wp_upload_dir();
  $path = path_join( $upload_dir['basedir'], dirname( $file ) );

  foreach ( $meta['sizes'] as $size ) {
    $thumbfile = str_replace( wp_basename( $file ), $size['file'], $file );

    if ( file_exists( $thumbfile ) ) {
      @unlink( $thumbfile );
    }
  }
}
```
- 返回结果：
  
  如果成功删除了原始文件和所有缩略图，则返回 true，否则返回 false。

代码示例

下面是一个简单的代码示例，演示如何使用 wp_delete_attachment 函数删除附件：

<?php
// 获取要删除的附件 ID
$attachment_id = $_GET['attachment_id'];

// 检查用户是否有删除附件的权限
if ( current_user_can( 'delete_post', $attachment_id ) ) {
  // 删除附件，并强制删除（绕过回收站）
  $result = wp_delete_attachment( $attachment_id, true );

  if ( $result ) {
    echo '附件删除成功！';
  } else {
    echo '附件删除失败！';
  }
} else {
  echo '您没有权限删除该附件！';
}
?>

注意事项

权限： 务必确保当前用户有删除附件的权限，否则删除操作将失败。
回收站： 默认情况下，附件会被移动到回收站，而不是直接删除。如果要强制删除，需要将 $force_delete 参数设置为 true。
钩子： 可以使用 delete_attachment 和 wp_delete_file 钩子来自定义删除过程。例如，可以在删除附件之前备份文件，或者在删除附件之后更新相关记录。
错误处理： 在删除文件时，使用 @ 符号来抑制错误信息。这是因为 unlink 函数在删除文件失败时会产生警告。但是，建议在生产环境中添加适当的错误处理机制，以便及时发现和解决问题。
文件系统权限： 确保 WordPress 进程拥有删除附件文件的权限。如果文件系统权限不正确，unlink 函数可能无法删除文件。
外部存储： 如果附件存储在外部存储服务（例如 Amazon S3），wp_delete_attachment 函数可能无法删除文件。需要自定义删除逻辑，调用外部存储服务的 API 来删除文件。

数据库表与字段的关联

为了更清晰地理解 wp_delete_attachment 的工作原理，我们来看一下涉及到的数据库表和字段：

表名	字段名	描述
`wp_posts`	`ID`	文章 ID（附件的 ID）
`wp_posts`	`post_type`	文章类型（对于附件，通常为 `attachment`）
`wp_posts`	`post_status`	文章状态（例如 `publish`、`trash`）
`wp_postmeta`	`post_id`	文章 ID（与 `wp_posts.ID` 关联）
`wp_postmeta`	`meta_key`	元数据键（例如 `_wp_attached_file`、`_wp_attachment_metadata`）
`wp_postmeta`	`meta_value`	元数据值（例如附件的文件路径、缩略图信息）

wp_delete_attachment 函数主要操作以下数据：

wp_posts 表： 删除 post_type 为 attachment 且 ID 为 $post_id 的记录。
wp_postmeta 表： 删除 post_id 为 $post_id 且 meta_key 为 _wp_attached_file 和 _wp_attachment_metadata 的记录。

钩子的作用

delete_attachment 和 wp_delete_file 这两个钩子为开发者提供了极大的灵活性，可以自定义附件删除过程。

delete_attachment 钩子： 在删除附件的数据库记录之前触发。可以用于执行一些清理操作，例如删除与附件相关的自定义数据。

add_action( 'delete_attachment', 'my_custom_delete_attachment' );

function my_custom_delete_attachment( $post_id ) {
  // 在这里执行自定义逻辑
  // 例如，删除与附件相关的自定义数据
  delete_post_meta( $post_id, 'my_custom_meta_key' );
}

wp_delete_file 钩子： 在删除附件的文件之前触发。可以用于执行一些备份操作，例如将附件文件复制到备份目录。

add_action( 'wp_delete_file', 'my_custom_wp_delete_file' );

function my_custom_wp_delete_file( $file ) {
  // 在这里执行自定义逻辑
  // 例如，将附件文件复制到备份目录
  $backup_dir = '/path/to/backup/directory';
  copy( $file, $backup_dir . '/' . basename( $file ) );
}

总结一下要点

wp_delete_attachment 是 WordPress 中一个非常重要的函数，它负责从数据库和文件系统中彻底删除附件。理解其内部逻辑，权限控制，数据库操作，文件删除流程，以及钩子的使用，可以帮助开发者更好地管理附件，保证系统的稳定性和数据的完整性。

WordPress 函数 wp_delete_attachment：文件系统与数据库间的同步逻辑

wp_delete_attachment 函数概览

wp_delete_attachment 的内部逻辑