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

お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア（2018年5月27日 更新）

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている（基本的にはiOSの）絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。（2024年11月13日 更新）

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア（Clear Unknown Formatting）」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。