wp_delete_attachment_files

説明

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



お勧め

時代はWP_Queryなのか(2011年8月1日 更新)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

3.6リリース直前チェック(2013年7月26日 更新)

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

投稿画面のウェジェットを2列にする(2013年4月17日 更新)

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。