説明
bool wp_delete_attachment_files( int $post_id, array $meta, array $backup_sizes, string $file )
添付ファイルとその関連ファイルを削除する。
パラメータ
- $post_idメディアの投稿IDを指定。
- $metaメディアのメタ情報の連想配列を指定。
- $backup_sizesメディアのバックアップサイズを格納した配列を指定。
- $file添付ファイルのパス名を指定。
返り値
添付ファイルとその関連ファイルが削除できた場合はtrue、いずれかが削除できなかった場合はfalseを返す。
注意
本関数は従来の wp_delete_attachment関数から切り出されたもので、wp_delete_attachment関数から呼び出される。削除対象となるメディアの添付ファイルは、画像ファイルの場合にサムネイルやいくつかのサイズが作成されることがあり、それら関連ファイルも同時に削除している。
パラメータ$metaの内容は、 wp_get_attachment_metadata関数で取得できる。
パラメータ$backup_sizesの内容は、 get_post_meta関数でキーに'_wp_attachment_backup_sizes'を指定して取得できる。
パラメータ$fileの内容は、 get_attached_file関数で取得できる。
使用例
- 添付ファイルとその関連ファイルを削除する。<?php wp_delete_attachment_files( $post_id, $meta, $backup_sizes, $file ); ?>
フィルター
実行するフィルターはありません。アクション
実行するアクションはありません。ソースファイル
/wp-includes/post.php最終更新 : 2018年07月06日 15:27
関連
お勧め
使っていないか確認しないとね！（フィルター編）（2019年4月24日 更新）
先週末にWordPress 5.2 Beta3（以降5.2Beta3）が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。
ブロックエディターで現在の「ロケール」を取得した時のメモ（2024年8月10日 更新）
ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール（言語）を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。
プラグインで注意が必要な関数（2013年11月27日 更新）
先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。
ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）
投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。カスタム投稿タイプの投稿保存には専用アクションを使おう（2014年7月4日 更新）
カスタム投稿タイプを登録して、専用ウィジェット（meta_box）を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。