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

お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する（2013年9月26日 更新）

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した（2023年1月25日 更新）

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日 更新）

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。