wp_delete_file()


WordPressの関数wp_delete_file()は、指定されたファイルをサーバーから削除するために使用されます。この関数は、ファイルパスを引数として受け取り、ファイルの削除が成功した場合は削除されたファイルパスを返します。

シンタックス

wp_delete_file( string $file );
  • $file (string) — 削除するファイルの絶対パス。

例 1. ファイルを削除する基本例

指定したファイルを削除するシンプルな例です。

<?php wp_delete_file( '/path/to/file.txt' ); ?>

例 2. メディアアップロードディレクトリのファイルを削除

wp_upload_dir()関数を使用して、アップロードディレクトリ内のファイルを削除します。

<?php
$upload_dir = wp_upload_dir();
$file_path = $upload_dir['basedir'] . '/example-file.jpg';
wp_delete_file( $file_path );
?>

例 3. 投稿のメタデータに基づいてファイルを削除

投稿のメタデータに保存されているファイルパスを使用して削除します。

<?php
$post_id = get_the_ID();
$file_path = get_post_meta( $post_id, '_custom_file_path', true );
if ( $file_path ) {
    wp_delete_file( $file_path );
}
?>

例 4. ファイル削除前に条件を確認

ファイルが存在するかどうかを確認してから削除します。

<?php
$file_path = '/path/to/another-file.txt';
if ( file_exists( $file_path ) ) {
    wp_delete_file( $file_path );
}
?>

例 5. メディアライブラリのファイルを削除

get_attached_file()を使用してメディアアイテムに関連付けられたファイルを削除します。

<?php
$attachment_id = 123; // 添付ファイルID
$file_path = get_attached_file( $attachment_id );
if ( $file_path ) {
    wp_delete_file( $file_path );
}
?>

注意事項

  • wp_delete_file()は直接ファイルを削除するため、使用する際には慎重に操作してください。
  • 削除するファイルのパスが正しいか確認してください。
  • 削除後にファイルが必要になる場合は、必ずバックアップを取ってください。

関連機能：