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

お勧め

任意の名前でエラーログファイルを指定する（2019年2月15日 更新）

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

テキストエディタの文字を変更する（2018年5月27日 更新）

テキストエディタ（投稿ページの「テキスト」タブのエディタ）に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。