説明
パラメータ
- $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
関連
お勧め
oEmbed対応サイトを整理した(2020年4月6日 更新)
投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。
5.7の機能拡張:エクスポートファイルに更新日時が追加ほか(2021年2月23日 更新)
WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。
絵文字画像がPNGからSVGへ(2018年5月27日 更新)
WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。
投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)
rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。