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

お勧め

6.2に追加されるsearch_columnsパラメータが便利（2023年3月30日 更新）

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル（post_title）、本文（post_content）、抜粋（post_excerpt）が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する（2013年3月9日 更新）

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo：プラグイン作ってみました（2019年9月19日 更新）

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

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

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