wp_delete_file

（4.2.0以降）
wp_delete_file - ファイルを削除する

説明

boolvoid wp_delete_file( string $file )
ファイルを削除する。

パラメータ

  • $file
    ファイルのパス名を指定。

返り値

[6.7.0]ファイルが削除された場合はtrueを、削除されなかった場合はfalseを返す。 返り値はありません。

注意

'wp_delete_file'フィルターは2.1.0から存在し、メディアなどで使用しなくなったファイルを削除する際の削除確認に使用されていた。4.2以降でファイルを削除する場合は、直接unlink関数を呼び出さないほうがいいのかも。

[6.7.0]ファイルの削除結果を返り値で返すようになった。

使用例

  • $pathで指定されたファイルを削除する。
    <?php
if ( function_exists( 'wp_delete_file' ) )
	wp_delete_file( $path );
else
	@unlink( $path );
?>

フィルター

[2.1.0]ファイルを削除する前に'wp_delete_file'フィルターを呼び出す。パラメータ$fileにはファイルのパス名が格納される。このフィルターで''のようなempty評価になる値を返すと、ファイルは削除されない。
$delete = apply_filters( 'wp_delete_file', $file );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/functions.php

最終更新 : 2024年11月15日 12:53

関連

参考

Code Reference: wp_delete_file

お勧め

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する（2012年3月15日 更新）

投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える（2014年9月12日 更新）

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。