概要
wp_delete_file関数は、指定したファイルを削除するためのWordPressの関数です。この関数は、特にメディア管理やカスタムアップロード機能を実装する際によく利用されます。以下は、よく使われるシナリオの例です。
- アップロードされた画像ファイルの削除
- 不要な添付ファイルのクリーンアップ
- 定期的なバックアップファイルの管理
- プラグインやテーマに関連するキャッシュファイルの削除
- ユーザーが削除したコンテンツに伴うファイルの削除
- 一時ファイルの管理
- 既存のファイルを新しいバージョンに置き換える際の古いファイルの削除
- オンラインストレージと連携したファイルの同期管理
構文
wp_delete_file( $file );
パラメータ
$file(string) – 削除するファイルのパス。ワードプレスのファイルシステムでは、相対パスまたは絶対パスを指定できます。
戻り値
- 成功した場合は
trueを返し、失敗した場合はfalseを返します。
関連する関数
使用可能なバージョン
wp_delete_fileは、WordPress 3.0以降で利用可能です。
コアファイルのパス
wp-includes/functions.php
この関数のアクションでの使用可能性
| アクション名 | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
- 特に非推奨や削除されたバージョンはありません。